pbapc_8h.html

BlueLab3 bluetooth API 说明文档

<p>
Abort the current multi-packet operation. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>pbapc</em>&nbsp;</td><td>PBAPC Session Handle.</td></tr>
  </table>
</dl>
The relevant COMPLETE_IND message will be received with the status code of pbapc_aborted on success.     </td>
  </tr>
</table>
<a class="anchor" name="a31" doxytag="pbapc.h::PbapcSetPhonebook" ></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 PbapcSetPhonebook           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="pbapc_8h.html#a1">PBAPC</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>pbapc</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="pbap__common_8h.html#a84">pbap_phone_repository</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>repository</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="pbap__common_8h.html#a85">pbap_phone_book</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>phonebook</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>
Change the current active phonebook. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>pbapc</em>&nbsp;</td><td>PBAPC Session Handle. </td></tr>
    <tr><td></td><td valign=top><em>repository</em>&nbsp;</td><td>Repository containing the new phonebook. </td></tr>
    <tr><td></td><td valign=top><em>phonebook</em>&nbsp;</td><td>The new phonebook.</td></tr>
  </table>
</dl>
To change to a different phonebook in the same repository, use pbap_current as the repository.<p>
PBAPC_SET_PHONEBOOK_CFM message will be received by the application.     </td>
  </tr>
</table>
<a class="anchor" name="a32" doxytag="pbapc.h::PbapcPacketComplete" ></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 PbapcPacketComplete           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="pbapc_8h.html#a1">PBAPC</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>pbapc</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>
The packet received has been processed and is no longer needed. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>pbapc</em>&nbsp;</td><td>PBAPC Session Handle (as returned in PBAPC_INIT_CFM).</td></tr>
  </table>
</dl>
Every packet send to the client that contains a source must be declared complete before the next function is called. e.g. When a PBAPC_PULL_VCARD_LIST_START_IND has been received, PbapcPacketComplete must be called before calling PbapcPullvCardListingNext.<p>
No message is received on completion.     </td>
  </tr>
</table>
<a class="anchor" name="a33" doxytag="pbapc.h::PbapcPullvCardListingStart" ></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 PbapcPullvCardListingStart           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="pbapc_8h.html#a1">PBAPC</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>pbapc</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="pbap__common_8h.html#a87">pbap_order_values</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>order</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="pbap__common_8h.html#a85">pbap_phone_book</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>pbook</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>srchVal</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>size_srchVal</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="pbap__common_8h.html#a88">pbap_search_values</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>srchAttr</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>maxList</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>listStart</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>
Start to get the vCard listing for the current phonebook. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>pbapc</em>&nbsp;</td><td>PBAPC Session Handle. </td></tr>
    <tr><td></td><td valign=top><em>order</em>&nbsp;</td><td>Result sort order. Use 'pbap_order_default' for default sort order. </td></tr>
    <tr><td></td><td valign=top><em>pbook</em>&nbsp;</td><td>Phonebook folder to retrieve. Use 'pbap_b_unknown' for the current folder. </td></tr>
    <tr><td></td><td valign=top><em>srchVal</em>&nbsp;</td><td>Value to search for. </td></tr>
    <tr><td></td><td valign=top><em>size_srchVal</em>&nbsp;</td><td>Length of the search value. </td></tr>
    <tr><td></td><td valign=top><em>srchAttr</em>&nbsp;</td><td>Attribute to search. Use 'pbap_a_unknown' for default search attribute. </td></tr>
    <tr><td></td><td valign=top><em>maxList</em>&nbsp;</td><td>Maximum List Count. </td></tr>
    <tr><td></td><td valign=top><em>listStart</em>&nbsp;</td><td>List Start Offset.</td></tr>
  </table>
</dl>
The ownership of the pointer 'srchVal' remains with the caller and must remain valid until a PBAPC_PULL_VCARD_LIST_START_IND message has been received.<p>
A PBAPC_PULL_VCARD_LIST_START_IND message will be received by the appliction when the first packet arrives. A PBAPC_PULL_VCARD_LIST_COMPLETE_IND message will be received after the last packet is received.     </td>
  </tr>
</table>
<a class="anchor" name="a34" doxytag="pbapc.h::PbapcPullvCardListingNext" ></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 PbapcPullvCardListingNext           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="pbapc_8h.html#a1">PBAPC</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>pbapc</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>
Get the next vCard listing packet for the current phonebook. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>pbapc</em>&nbsp;</td><td>PBAPC Session Handle.</td></tr>
  </table>
</dl>
A PBAPC_PULL_VCARD_LIST_DATA_IND message will be received by the appliction for each packet after the first. A PBAPC_PULL_VCARD_LIST_COMPLETE_IND message will be received after the last packet is received.     </td>
  </tr>
</table>
<a class="anchor" name="a35" doxytag="pbapc.h::PbapcPullvCardEntryStart" ></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 PbapcPullvCardEntryStart           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="pbapc_8h.html#a1">PBAPC</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>pbapc</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>entry</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>