classcradiusattribute.html

来自「采用 ACE 开发的 radius 应用」· HTML 代码 · 共 1,454 行 · 第 1/4 页

<a class="anchor" name="a12" doxytag="CRadiusAttribute::getNumber" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> ACE_UINT32 CRadiusAttribute::getNumber           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get value of the numeric attribute. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>value of numeric attribute in host order format </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a16" doxytag="CRadiusAttribute::getString" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> int CRadiusAttribute::getString           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned char *&amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>p_data</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>ACE_UINT16 &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>p_length</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get value of the string attribute. 
<p>
Note that string data may contain both readable characters and non-readable binary data. In any case string will not be null-terminated, hence application should use returned p_length value to properly operate with it.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td><tt>[out]</tt>&nbsp;</td><td valign=top><em>p_data</em>&nbsp;</td><td>- pointer to the beginning of string data </td></tr>
    <tr><td><tt>[out]</tt>&nbsp;</td><td valign=top><em>p_length</em>&nbsp;</td><td>- string length </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>RC_SUCCESS or RC_FAIL </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a6" doxytag="CRadiusAttribute::getType" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> unsigned char CRadiusAttribute::getType           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get attribute type. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>attribute type </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a32" doxytag="CRadiusAttribute::getUserPassword" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> int CRadiusAttribute::getUserPassword           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned char&nbsp;</td>
          <td class="mdname" nowrap> <em>p_data</em>[], </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>ACE_UINT16 &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>p_length</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classCRadiusSecret.html">CRadiusSecret</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>p_secret</em> = <code>NULL</code></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get string data of User-Password attribute. 
<p>
Password is decoded from the packet using secret key and presented in it's "original" form. Note that string data may contain both readable characters and non-readable binary data. In any case string will not be null-terminated, hence application should use returned p_length value to properly operate with it.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td><tt>[in]</tt>&nbsp;</td><td valign=top><em>p_data</em>&nbsp;</td><td>- pointer to local buffer allocated by application where the decoded password will be stored </td></tr>
    <tr><td><tt>[out]</tt>&nbsp;</td><td valign=top><em>p_length</em>&nbsp;</td><td>- string length </td></tr>
    <tr><td><tt>[in]</tt>&nbsp;</td><td valign=top><em>p_secret</em>&nbsp;</td><td>- secret key (if NULL, stack's secret key is taken) </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>RC_SUCCESS or RC_FAIL</dd></dl>
IMPORTANT: application should allocate the buffer of size D_USER_PASSWORD_MAX_LENGTH for storing decoded password data and pass it as p_data     </td>
  </tr>
</table>
<a class="anchor" name="a28" doxytag="CRadiusAttribute::getVendorExtAddress" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> struct in_addr CRadiusAttribute::getVendorExtAddress           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get value of the vendor-specific IP address attribute. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>value of IP address attribute </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a26" doxytag="CRadiusAttribute::getVendorExtNumber" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> ACE_UINT32 CRadiusAttribute::getVendorExtNumber           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get value of the numeric attribute. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>value of numeric attribute in host order format </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a30" doxytag="CRadiusAttribute::getVendorExtString" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> int CRadiusAttribute::getVendorExtString           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned char *&amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>p_data</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>ACE_UINT16 &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>p_length</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get value of the vendor-specific string attribute. 
<p>
Note that string data may contain both readable characters and non-readable binary data. In any case string will not be null-terminated, hence application should use returned p_length value to properly operate with it.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td><tt>[out]</tt>&nbsp;</td><td valign=top><em>p_data</em>&nbsp;</td><td>- pointer to the beginning of string data </td></tr>
    <tr><td><tt>[out]</tt>&nbsp;</td><td valign=top><em>p_length</em>&nbsp;</td><td>- string length </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>RC_SUCCESS or RC_FAIL </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a18" doxytag="CRadiusAttribute::getVendorId" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> ACE_UINT32 CRadiusAttribute::getVendorId           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get vendor ID of Vendor-Specific attribute. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>vendor ID numeric value in host order format </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a24" doxytag="CRadiusAttribute::getVendorLength" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> unsigned char CRadiusAttribute::getVendorLength           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get vendor length of Vendor-Specific attribute. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>vendor length </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a20" doxytag="CRadiusAttribute::getVendorString" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> int CRadiusAttribute::getVendorString           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned char *&amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>p_data</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>ACE_UINT16 &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>p_length</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>