pbap__common_8h.html

BlueLab3 bluetooth API 说明文档

</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a89" doxytag="pbap_common.h::pbap_format_values" ></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"> enum <a class="el" href="pbap__common_8h.html#a89">pbap_format_values</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
vCard formats to use with the PullvCardEntry and PullPhonebook functions. 
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="a89a73" doxytag="pbap_format_21" ></a>pbap_format_21</em>&nbsp;</td><td>
vCard 2.1. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a89a74" doxytag="pbap_format_30" ></a>pbap_format_30</em>&nbsp;</td><td>
vCard 3.0 </td></tr>
<tr><td valign=top><em><a class="anchor" name="a89a75" doxytag="pbap_format_def" ></a>pbap_format_def</em>&nbsp;</td><td>
Use default value </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="a76" doxytag="pbap_common.h::PbapcoGetRepositoryNameFromID" ></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"> const <a class="el" href="csrtypes_8h.html#a8">uint8</a>* PbapcoGetRepositoryNameFromID           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="pbap__common_8h.html#a84">pbap_phone_repository</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>repos</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>len</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>
Convert a phone Repository ID into a phone Repository name. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>store</em>&nbsp;</td><td>Store to find the name of </td></tr>
    <tr><td></td><td valign=top><em>len</em>&nbsp;</td><td>Length of the returned name</td></tr>
  </table>
</dl>
Returns Pointer to the Repository name. len contains the length of the returned name. On Error returns NULL and the contents of len are unchanged.<p>
The pointer MUST NOT be freed.     </td>
  </tr>
</table>
<a class="anchor" name="a77" doxytag="pbap_common.h::PbapcoGetRepositoryIDFromName" ></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="pbap__common_8h.html#a84">pbap_phone_repository</a> PbapcoGetRepositoryIDFromName           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>repos</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>len</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>
Convert a phone Repository name into a phone Repository ID. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>store</em>&nbsp;</td><td>Store to find the ID of </td></tr>
    <tr><td></td><td valign=top><em>len</em>&nbsp;</td><td>Length of the Repository name</td></tr>
  </table>
</dl>
Returns Store ID. On Error returns pbap_r_unknown.    </td>
  </tr>
</table>
<a class="anchor" name="a78" doxytag="pbap_common.h::PbapcoGetBookNameFromID" ></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"> const <a class="el" href="csrtypes_8h.html#a8">uint8</a>* PbapcoGetBookNameFromID           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="pbap__common_8h.html#a85">pbap_phone_book</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>book</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>len</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>
Convert a phone book ID into a phone book name. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>book</em>&nbsp;</td><td>Book to find the name of </td></tr>
    <tr><td></td><td valign=top><em>len</em>&nbsp;</td><td>Length of the returned name</td></tr>
  </table>
</dl>
Returns Pointer to the book name. len contains the length of the returned name. On Error returns NULL and the contents of len are unchanged.<p>
The pointer MUST NOT be freed.     </td>
  </tr>
</table>
<a class="anchor" name="a79" doxytag="pbap_common.h::PbapcoGetBookIDFromName" ></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="pbap__common_8h.html#a85">pbap_phone_book</a> PbapcoGetBookIDFromName           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>book</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>len</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>
Convert a phone book name into a phone book ID. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>book</em>&nbsp;</td><td>Book to find the ID of </td></tr>
    <tr><td></td><td valign=top><em>len</em>&nbsp;</td><td>Length of the book name</td></tr>
  </table>
</dl>
Returns Book ID. On Error returns pbap_b_unknown.    </td>
  </tr>
</table>
<a class="anchor" name="a80" doxytag="pbap_common.h::PbapcoGetTargetString" ></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"> const <a class="el" href="csrtypes_8h.html#a8">uint8</a>* PbapcoGetTargetString           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a4">uint16</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>len</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 a pointer to the PBAB target string. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>len</em>&nbsp;</td><td>Length of the returned name</td></tr>
  </table>
</dl>
Returns Pointer to the target. len contains the length of the returned name.<p>
The pointer MUST NOT be freed.     </td>
  </tr>
</table>
<a class="anchor" name="a81" doxytag="pbap_common.h::PbapcoGetvCardListingMimeType" ></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"> const <a class="el" href="csrtypes_8h.html#a8">uint8</a>* PbapcoGetvCardListingMimeType           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a4">uint16</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>len</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 a pointer to the PBAB vCard Listing mime type. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>len</em>&nbsp;</td><td>Length of the returned name</td></tr>
  </table>
</dl>
Returns Pointer to the string. len contains the length of the returned string.<p>
The pointer MUST NOT be freed.     </td>
  </tr>
</table>
<a class="anchor" name="a82" doxytag="pbap_common.h::PbapcoGetvCardMimeType" ></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"> const <a class="el" href="csrtypes_8h.html#a8">uint8</a>* PbapcoGetvCardMimeType           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a4">uint16</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>len</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 a pointer to the PBAB vCard mime type. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>len</em>&nbsp;</td><td>Length of the returned name</td></tr>
  </table>
</dl>
Returns Pointer to the string. len contains the length of the returned string.<p>
The pointer MUST NOT be freed.     </td>
  </tr>
</table>
<a class="anchor" name="a83" doxytag="pbap_common.h::PbapcoGetPhonebookMimeType" ></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"> const <a class="el" href="csrtypes_8h.html#a8">uint8</a>* PbapcoGetPhonebookMimeType           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a4">uint16</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>len</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 a pointer to the PBAB Phonebook mime type. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>len</em>&nbsp;</td><td>Length of the returned name</td></tr>
  </table>
</dl>
Returns Pointer to the string. len contains the length of the returned string.<p>
The pointer MUST NOT be freed.     </td>
  </tr>
</table>

</body>
</html>