goep__apphdrs_8h.html

BlueLab3 bluetooth API 说明文档

          <td class="mdname" nowrap> <em>snk</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a8">uint8</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>paramID</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a3">uint32</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>param</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>
Add a uint32 parameter to the GOEP Packet. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>snk</em>&nbsp;</td><td>Sink to add the parameter to </td></tr>
    <tr><td></td><td valign=top><em>paramID</em>&nbsp;</td><td>Identifier of the parameter </td></tr>
    <tr><td></td><td valign=top><em>param</em>&nbsp;</td><td>Actual parameter to add</td></tr>
  </table>
</dl>
Returns length used to add the paramter. Zero (0) is returned on error.     </td>
  </tr>
</table>
<a class="anchor" name="a7" doxytag="goep_apphdrs.h::Goep_apphdr_AddUint64" ></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"> <a class="el" href="csrtypes_8h.html#a4">uint16</a> Goep_apphdr_AddUint64           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="sink___8h.html#a0">Sink</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>snk</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a8">uint8</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>paramID</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a3">uint32</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>param_lo</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a3">uint32</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>param_hi</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>
Add a uint64 parameter to the GOEP Packet. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>snk</em>&nbsp;</td><td>Sink to add the parameter to </td></tr>
    <tr><td></td><td valign=top><em>paramID</em>&nbsp;</td><td>Identifier of the parameter </td></tr>
    <tr><td></td><td valign=top><em>param_lo</em>&nbsp;</td><td>Low 32 bits (0..31) of the actual parameter to add </td></tr>
    <tr><td></td><td valign=top><em>param_hi</em>&nbsp;</td><td>High 32 bits (31..63) of the actual parameter to add</td></tr>
  </table>
</dl>
Returns length used to add the paramter. Zero (0) is returned on error. On return, the offset points to the next offset that can accept a parameter    </td>
  </tr>
</table>
<a class="anchor" name="a8" doxytag="goep_apphdrs.h::Goep_apphdr_AddBuffer" ></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"> <a class="el" href="csrtypes_8h.html#a4">uint16</a> Goep_apphdr_AddBuffer           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="sink___8h.html#a0">Sink</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>snk</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a8">uint8</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>paramID</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>param</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a8">uint8</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>size_param</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>
Add a buffer parameter to the GOEP Packet. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>snk</em>&nbsp;</td><td>Sink to add the parameter to </td></tr>
    <tr><td></td><td valign=top><em>paramID</em>&nbsp;</td><td>Identifier of the parameter </td></tr>
    <tr><td></td><td valign=top><em>param</em>&nbsp;</td><td>Actual parameter to add </td></tr>
    <tr><td></td><td valign=top><em>length</em>&nbsp;</td><td>Length of the buffer</td></tr>
  </table>
</dl>
Returns length used to add the paramter. Zero (0) is returned on error.     </td>
  </tr>
</table>
<a class="anchor" name="a9" doxytag="goep_apphdrs.h::Goep_apphdr_GetCreateWS" ></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"> void* Goep_apphdr_GetCreateWS           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="source___8h.html#a0">Source</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>src</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a4">uint16</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>offset</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a4">uint16</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>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>
Create a workspace to get Application Specific Parameters. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>src</em>&nbsp;</td><td>Source containting the parameters </td></tr>
    <tr><td></td><td valign=top><em>offset</em>&nbsp;</td><td>Offset into the source for the parameter header </td></tr>
    <tr><td></td><td valign=top><em>length</em>&nbsp;</td><td>Length of the parameter header</td></tr>
  </table>
</dl>
Returns void pointer to be used for follow up calls to this library. NULL on error.     </td>
  </tr>
</table>
<a class="anchor" name="a10" doxytag="goep_apphdrs.h::Goep_apphdr_GetParameter" ></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"> <a class="el" href="csrtypes_8h.html#a9">bool</a> Goep_apphdr_GetParameter           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void *&nbsp;</td>
          <td class="mdname" nowrap> <em>workspace</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a8">uint8</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>paramID</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a4">uint16</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>param</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a8">uint8</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>size_param</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 the next paramter from the GOEP header. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>workspace</em>&nbsp;</td><td>Pointer returned from Goep_apphdr_GetCreateWS. </td></tr>
    <tr><td></td><td valign=top><em>paramID</em>&nbsp;</td><td>ID of the next parameter </td></tr>
    <tr><td></td><td valign=top><em>param</em>&nbsp;</td><td>Offset to the parameter in the source </td></tr>
    <tr><td></td><td valign=top><em>size_param</em>&nbsp;</td><td>Size of the next parameter</td></tr>
  </table>
</dl>
Returns TRUE if there are no more paramters, and FALSE if there are.     </td>
  </tr>
</table>
<a class="anchor" name="a11" doxytag="goep_apphdrs.h::Goep_apphdr_GetDestroyWS" ></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"> void Goep_apphdr_GetDestroyWS           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>workspace</em>          </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>
Destroy the workspace for Application Specific Parameter retrieval. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>workspace</em>&nbsp;</td><td>Pointer returned from Goep_apphdr_GetCreateWS. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>

</body>
</html>