📄 pbap__common_8h.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>BlueLab: pbap_common.h File Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.8 --><div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div><h1>pbap_common.h File Reference</h1>Helper library for PhoneBook Access Profile Server and Client Libraries. <a href="#_details">More...</a><p><h2>SDP Attributes</h2>SDP Attribute defines. <ul><li>#define <a class="el" href="pbap__common_8h.html#a0">PBAP_REPOS</a> 0x0314<dl class="el"><dd class="mdescRight">Supported Repositories UUID. <a href="#a0"></a><br></dl></ul><h2>Supported Repositories</h2>Mask Values for Supported Repositories<p>These values are masked together to generate the supported repositories for SDP registration and searching. <ul><li>#define <a class="el" href="pbap__common_8h.html#a1">PBAP_REP_LOCAL</a> (1<<0)<dl class="el"><dd class="mdescRight">Mask for Local Repository. <a href="#a1"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a2">PBAP_REP_SIM1</a> (1<<1)<dl class="el"><dd class="mdescRight">Mask for SIM1 Repository. <a href="#a2"></a><br></dl></ul><h2>Supported features</h2>Mask Values for Supported Features<p>These values are masked together to generate the supported features for SDP registration and searching. <ul><li>#define <a class="el" href="pbap__common_8h.html#a3">PBAP_SUP_DOWNLOAD</a> (1<<0)<dl class="el"><dd class="mdescRight">Mask for Phonebook Download. <a href="#a3"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a4">PBAP_SUP_BROWSE</a> (1<<1)<dl class="el"><dd class="mdescRight">Mask for Phonebook Browsing. <a href="#a4"></a><br></dl></ul><h2>Parameter Default Values.</h2>Phonebook Access Profile Specific Parameter Default Values. <ul><li>#define <a class="el" href="pbap__common_8h.html#a5">pbap_param_order_def</a> pbap_order_idx<dl class="el"><dd class="mdescRight">Order. [Indexed]. <a href="#a5"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a6">pbap_param_srch_attr_def</a> pbap_search_name<dl class="el"><dd class="mdescRight">Search Atribute. [Name]. <a href="#a6"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a7">pbap_param_max_list_def</a> 65535<dl class="el"><dd class="mdescRight">Maximum List Count. [All / Unrestricted]. <a href="#a7"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a8">pbap_param_strt_offset_def</a> 0<dl class="el"><dd class="mdescRight">List Start Offset. [Start from item 0]. <a href="#a8"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a9">pbap_param_filter_def</a> 0<dl class="el"><dd class="mdescRight">Filter. [No Filter]. <a href="#a9"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a10">pbap_param_format_def</a> pbap_format_21<dl class="el"><dd class="mdescRight">Format. [vCard 2.1]. <a href="#a10"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a11">pbap_param_pbook_size_def</a> 0<dl class="el"><dd class="mdescRight">Phonebook Size. [Unknown]. <a href="#a11"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a12">pbap_param_missed_calls_def</a> 0<dl class="el"><dd class="mdescRight">New Missed Calls. [No new]. <a href="#a12"></a><br></dl></ul><h2>Filter Attribute Mask Values.</h2>Mask values for the Phonebook Access Profile Specific Parameter Filter. <ul><li>#define <a class="el" href="pbap__common_8h.html#a13">pbap_filter_version</a> (1<<0)<dl class="el"><dd class="mdescRight">vCard Version (VERSION). <a href="#a13"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a14">pbap_filter_fn</a> (1<<1)<dl class="el"><dd class="mdescRight">Formatted Name (FN). <a href="#a14"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a15">pbap_filter_n</a> (1<<2)<dl class="el"><dd class="mdescRight">Structured Presentation of Name (N). <a href="#a15"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a16">pbap_filter_photo</a> (1<<3)<dl class="el"><dd class="mdescRight">Photo Associated with the name (PHOTO). <a href="#a16"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a17">pbap_filter_bday</a> (1<<4)<dl class="el"><dd class="mdescRight">Birthday (BDAY). <a href="#a17"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a18">pbap_filter_adr</a> (1<<5)<dl class="el"><dd class="mdescRight">Delivery Address (ADR). <a href="#a18"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a19">pbap_filter_label</a> (1<<6)<dl class="el"><dd class="mdescRight">Delivery Label (LABEL). <a href="#a19"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a20">pbap_filter_tel</a> (1<<7)<dl class="el"><dd class="mdescRight">Telephone Number (TEL). <a href="#a20"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a21">pbap_filter_email</a> (1<<8)<dl class="el"><dd class="mdescRight">Electronic Mail Address (EMAIL). <a href="#a21"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a22">pbap_filter_mailer</a> (1<<9)<dl class="el"><dd class="mdescRight">Electronic Mail (MAILER). <a href="#a22"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a23">pbap_filter_tz</a> (1<<10)<dl class="el"><dd class="mdescRight">Time Zone (TZ). <a href="#a23"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a24">pbap_filter_geo</a> (1<<11)<dl class="el"><dd class="mdescRight">Geographic Position (GEO). <a href="#a24"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a25">pbap_filter_title</a> (1<<12)<dl class="el"><dd class="mdescRight">Job Title (TITLE). <a href="#a25"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a26">pbap_filter_role</a> (1<<13)<dl class="el"><dd class="mdescRight">Role within the Organisation (ROLE). <a href="#a26"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a27">pbap_filter_logo</a> (1<<14)<dl class="el"><dd class="mdescRight">Organisation Logo (LOGO). <a href="#a27"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a28">pbap_filter_agent</a> (1<<15)<dl class="el"><dd class="mdescRight">vCard of person representing (AGENT). <a href="#a28"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a29">pbap_filter_org</a> (1<<16)<dl class="el"><dd class="mdescRight">Name of the Organisation (ORG). <a href="#a29"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a30">pbap_filter_note</a> (1<<17)<dl class="el"><dd class="mdescRight">Comments (NOTE). <a href="#a30"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a31">pbap_filter_rev</a> (1<<18)<dl class="el"><dd class="mdescRight">vCard Revision (REV). <a href="#a31"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a32">pbap_filter_sound</a> (1<<19)<dl class="el"><dd class="mdescRight">Pronunciation of Name (SOUND). <a href="#a32"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a33">pbap_filter_url</a> (1<<20)<dl class="el"><dd class="mdescRight">URL (URL). <a href="#a33"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a34">pbap_filter_uid</a> (1<<21)<dl class="el"><dd class="mdescRight">Unique ID (UID). <a href="#a34"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a35">pbap_filter_key</a> (1<<22)<dl class="el"><dd class="mdescRight">Public Encryption Key (KEY). <a href="#a35"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a36">pbap_filter_nickname</a> (1<<23)<dl class="el"><dd class="mdescRight">Nickname (NICKNAME). <a href="#a36"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a37">pbap_filter_catagory</a> (1<<24)<dl class="el"><dd class="mdescRight">Catagories (CATAGORIES). <a href="#a37"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a38">pbap_filter_proid</a> (1<<25)<dl class="el"><dd class="mdescRight">Product ID (PROID). <a href="#a38"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a39">pbap_filter_class</a> (1<<26)<dl class="el"><dd class="mdescRight">Class Information (CLASS). <a href="#a39"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a40">pbap_filter_sort</a> (1<<27)<dl class="el"><dd class="mdescRight">String used for sorting operations (SORT-STRING). <a href="#a40"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a41">pbap_filter_call_datetime</a> (1<<28)<dl class="el"><dd class="mdescRight">Timestamp (X-IRMC-CALL-DATETIME). <a href="#a41"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a42">pbap_filter_hi_proprietary</a> (1<<8)<dl class="el"><dd class="mdescRight">Proprietary filters in use. Used in the HIGH 32 bits. <a href="#a42"></a><br></dl></ul><h2>Manditory Filter Attribute Mask Values.</h2>Manditory Mask values for the Phonebook Access Profile Specific Parameter Filter. <ul><li>#define <a class="el" href="pbap__common_8h.html#a43">pbap_filter_vcard21</a> (pbap_filter_n | pbap_filter_tel)<dl class="el"><dd class="mdescRight">vCard version 2.1 manditory attributes. <a href="#a43"></a><br></dl><li>#define <a class="el" href="pbap__common_8h.html#a44">pbap_filter_vcard30</a> (pbap_filter_fn | pbap_filter_tel)<dl class="el"><dd class="mdescRight">vCard version 3.0 manditory attributes. <a href="#a44"></a><br></dl></ul><h2>Enumerations</h2><ul><li>enum <a class="el" href="pbap__common_8h.html#a84">pbap_phone_repository</a> { <br> <a class="el" href="pbap__common_8h.html#a84a45">pbap_current</a>, <br> <a class="el" href="pbap__common_8h.html#a84a46">pbap_local</a>, <br> <a class="el" href="pbap__common_8h.html#a84a47">pbap_sim1</a>, <br> <a class="el" href="pbap__common_8h.html#a84a48">pbap_r_unknown</a><br> }<dl class="el"><dd class="mdescRight">Valid phonebook repositories. <a href="#a84">More...</a><br></dl><li>enum <a class="el" href="pbap__common_8h.html#a85">pbap_phone_book</a> { <br> <a class="el" href="pbap__common_8h.html#a85a49">pbap_telecom</a>, <br> <a class="el" href="pbap__common_8h.html#a85a50">pbap_pb</a>, <br> <a class="el" href="pbap__common_8h.html#a85a51">pbap_ich</a>, <br> <a class="el" href="pbap__common_8h.html#a85a52">pbap_och</a>, <br> <a class="el" href="pbap__common_8h.html#a85a53">pbap_mch</a>, <br> <a class="el" href="pbap__common_8h.html#a85a54">pbap_cch</a>, <br> <a class="el" href="pbap__common_8h.html#a85a55">pbap_b_unknown</a><br> }<dl class="el"><dd class="mdescRight">Valid phonebook folders. <a href="#a85">More...</a><br></dl><li>enum <a class="el" href="pbap__common_8h.html#a86">pbap_goep_parameters</a> { <br> <a class="el" href="pbap__common_8h.html#a86a56">pbap_param_order</a> = 0x01, <br> <a class="el" href="pbap__common_8h.html#a86a57">pbap_param_srch_val</a> = 0x02, <br> <a class="el" href="pbap__common_8h.html#a86a58">pbap_param_srch_attr</a> = 0x03, <br> <a class="el" href="pbap__common_8h.html#a86a59">pbap_param_max_list</a> = 0x04, <br> <a class="el" href="pbap__common_8h.html#a86a60">pbap_param_strt_offset</a> = 0x05, <br> <a class="el" href="pbap__common_8h.html#a86a61">pbap_param_filter</a> = 0x06, <br> <a class="el" href="pbap__common_8h.html#a86a62">pbap_param_format</a> = 0x07, <br> <a class="el" href="pbap__common_8h.html#a86a63">pbap_param_pbook_size</a> = 0x08, <br> <a class="el" href="pbap__common_8h.html#a86a64">pbap_param_missed_calls</a> = 0x09<br> }<dl class="el"><dd class="mdescRight">Phonebook Access Profile Specific Parameters. <a href="#a86">More...</a><br></dl><li>enum <a class="el" href="pbap__common_8h.html#a87">pbap_order_values</a> { <br> <a class="el" href="pbap__common_8h.html#a87a65">pbap_order_idx</a> = 0x00, <br> <a class="el" href="pbap__common_8h.html#a87a66">pbap_order_alpha</a> = 0x01, <br> <a class="el" href="pbap__common_8h.html#a87a67">pbap_order_phone</a> = 0x02, <br> <a class="el" href="pbap__common_8h.html#a87a68">pbap_order_default</a><br> }<dl class="el"><dd class="mdescRight">Order values for use with the PullvCardListing function. <a href="#a87">More...</a><br></dl><li>enum <a class="el" href="pbap__common_8h.html#a88">pbap_search_values</a> { <br> <a class="el" href="pbap__common_8h.html#a88a69">pbap_search_name</a> = 0x00, <br> <a class="el" href="pbap__common_8h.html#a88a70">pbap_search_number</a> = 0x01, <br> <a class="el" href="pbap__common_8h.html#a88a71">pbap_search_sound</a> = 0x02, <br> <a class="el" href="pbap__common_8h.html#a88a72">pbap_a_unknown</a><br> }<dl class="el"><dd class="mdescRight">Search Attributes to use with the PullvCardListing function. <a href="#a88">More...</a><br></dl><li>enum <a class="el" href="pbap__common_8h.html#a89">pbap_format_values</a> { <br> <a class="el" href="pbap__common_8h.html#a89a73">pbap_format_21</a> = 0x00, <br> <a class="el" href="pbap__common_8h.html#a89a74">pbap_format_30</a> = 0x01, <br> <a class="el" href="pbap__common_8h.html#a89a75">pbap_format_def</a><br> }<dl class="el"><dd class="mdescRight">vCard formats to use with the PullvCardEntry and PullPhonebook functions. <a href="#a89">More...</a><br></dl></ul><h2>Functions</h2><ul><li>const <a class="el" href="csrtypes_8h.html#a8">uint8</a> * <a class="el" href="pbap__common_8h.html#a76">PbapcoGetRepositoryNameFromID</a> (<a class="el" href="pbap__common_8h.html#a84">pbap_phone_repository</a> repos, <a class="el" href="csrtypes_8h.html#a4">uint16</a> *len)<dl class="el"><dd class="mdescRight">Convert a phone Repository ID into a phone Repository name. <a href="#a76"></a><br></dl><li><a class="el" href="pbap__common_8h.html#a84">pbap_phone_repository</a> <a class="el" href="pbap__common_8h.html#a77">PbapcoGetRepositoryIDFromName</a> (const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *repos, <a class="el" href="csrtypes_8h.html#a4">uint16</a> len)<dl class="el"><dd class="mdescRight">Convert a phone Repository name into a phone Repository ID. <a href="#a77"></a><br></dl><li>const <a class="el" href="csrtypes_8h.html#a8">uint8</a> * <a class="el" href="pbap__common_8h.html#a78">PbapcoGetBookNameFromID</a> (<a class="el" href="pbap__common_8h.html#a85">pbap_phone_book</a> book, <a class="el" href="csrtypes_8h.html#a4">uint16</a> *len)<dl class="el"><dd class="mdescRight">Convert a phone book ID into a phone book name. <a href="#a78"></a><br></dl><li><a class="el" href="pbap__common_8h.html#a85">pbap_phone_book</a> <a class="el" href="pbap__common_8h.html#a79">PbapcoGetBookIDFromName</a> (const <a class="el" href="csrtypes_8h.html#a8">uint8</a> *book, <a class="el" href="csrtypes_8h.html#a4">uint16</a> len)<dl class="el"><dd class="mdescRight">Convert a phone book name into a phone book ID. <a href="#a79"></a><br></dl><li>const <a class="el" href="csrtypes_8h.html#a8">uint8</a> * <a class="el" href="pbap__common_8h.html#a80">PbapcoGetTargetString</a> (<a class="el" href="csrtypes_8h.html#a4">uint16</a> *len)<dl class="el"><dd class="mdescRight">Get a pointer to the PBAB target string. <a href="#a80"></a><br></dl><li>const <a class="el" href="csrtypes_8h.html#a8">uint8</a> * <a class="el" href="pbap__common_8h.html#a81">PbapcoGetvCardListingMimeType</a> (<a class="el" href="csrtypes_8h.html#a4">uint16</a> *len)<dl class="el"><dd class="mdescRight">Get a pointer to the PBAB vCard Listing mime type. <a href="#a81"></a><br></dl><li>const <a class="el" href="csrtypes_8h.html#a8">uint8</a> * <a class="el" href="pbap__common_8h.html#a82">PbapcoGetvCardMimeType</a> (<a class="el" href="csrtypes_8h.html#a4">uint16</a> *len)<dl class="el"><dd class="mdescRight">Get a pointer to the PBAB vCard mime type. <a href="#a82"></a><br></dl><li>const <a class="el" href="csrtypes_8h.html#a8">uint8</a> * <a class="el" href="pbap__common_8h.html#a83">PbapcoGetPhonebookMimeType</a> (<a class="el" href="csrtypes_8h.html#a4">uint16</a> *len)<dl class="el"><dd class="mdescRight">Get a pointer to the PBAB Phonebook mime type. <a href="#a83"></a><br></dl></ul><hr><a name="_details"></a><h2>Detailed Description</h2>Helper library for PhoneBook Access Profile Server and Client Libraries. <p>Library Dependecies : None<hr><h2>Define Documentation</h2><a class="anchor" name="a0" doxytag="pbap_common.h::PBAP_REPOS" ></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"> #define PBAP_REPOS 0x0314 </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Supported Repositories UUID. <p> </td> </tr></table><a class="anchor" name="a1" doxytag="pbap_common.h::PBAP_REP_LOCAL" ></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"> #define PBAP_REP_LOCAL (1<<0) </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Mask for Local Repository. <p> </td> </tr></table><a class="anchor" name="a2" doxytag="pbap_common.h::PBAP_REP_SIM1" ></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"> #define PBAP_REP_SIM1 (1<<1) </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Mask for SIM1 Repository. <p> </td> </tr></table><a class="anchor" name="a3" doxytag="pbap_common.h::PBAP_SUP_DOWNLOAD" ></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"> #define PBAP_SUP_DOWNLOAD (1<<0) </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Mask for Phonebook Download. <p> </td> </tr></table><a class="anchor" name="a4" doxytag="pbap_common.h::PBAP_SUP_BROWSE" ></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"> #define PBAP_SUP_BROWSE (1<<1) </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Mask for Phonebook Browsing. <p> </td> </tr></table><a class="anchor" name="a5" doxytag="pbap_common.h::pbap_param_order_def" ></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"> #define pbap_param_order_def pbap_order_idx </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Order. [Indexed]. <p> </td> </tr></table><a class="anchor" name="a6" doxytag="pbap_common.h::pbap_param_srch_attr_def" ></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"> #define pbap_param_srch_attr_def pbap_search_name </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Search Atribute. [Name]. <p> </td> </tr></table><a class="anchor" name="a7" doxytag="pbap_common.h::pbap_param_max_list_def" ></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"> #define pbap_param_max_list_def 65535 </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Maximum List Count. [All / Unrestricted]. <p> </td> </tr></table><a class="anchor" name="a8" doxytag="pbap_common.h::pbap_param_strt_offset_def" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -