<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>meanwhile: mw_srvc_dir.h File Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.4 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="classes.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <h1>mw_srvc_dir.h File Reference</h1> <p> <code>#include <glib.h></code><br> <code>#include <glib/glist.h></code><br> <p> <a href="mw__srvc__dir_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwDirectoryHandler.html">mwDirectoryHandler</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">handles asynchronous events for a directory service instance <a href="structmwDirectoryHandler.html#_details">More...</a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structmwDirectoryMember.html">mwDirectoryMember</a></td></tr> <tr><td colspan="2"><br><h2>Defines</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#d14f85f7524da53701b6815b40bd3031">_MW_SERV_DIR_H</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#9e8e363d3e984cb248f780ecf7c669b7">DIR_SEARCH_ERROR</a> 0x00000000</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">return value of directory searches that fail <a href="#9e8e363d3e984cb248f780ecf7c669b7"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#3e71e58bfa721b29af1e8e6bea0c210d">MW_DIRECTORY_IS_NEW</a>(dir) MW_DIRECTORY_IS_STATE((dir), mwDirectory_NEW)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#59dee2af6e326396710262410a83727b">MW_DIRECTORY_IS_OPEN</a>(dir) MW_DIRECTORY_IS_STATE((dir), mwDirectory_OPEN)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#61b98cd6f71f89e50d37d1976c1b7e1f">MW_DIRECTORY_IS_PENDING</a>(dir) MW_DIRECTORY_IS_STATE((dir), mwDirectory_PENDING)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#31c29620bbcc76eed48040a16a7c0af1">MW_DIRECTORY_IS_STATE</a>(dir, <a class="el" href="structmwService.html#b5adc0f5a0cbeddaece7a4512ec66099">state</a>) (mwDirectory_getState(dir) == (<a class="el" href="structmwService.html#b5adc0f5a0cbeddaece7a4512ec66099">state</a>))</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#e09f7e7e838b943ab68103d5be873cf6">SERVICE_DIRECTORY</a> 0x0000001a</td></tr> <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#81dc6682023f70d8bf2e523fdf37e77e">mwSearchHandler</a> )(struct <a class="el" href="structmwDirectory.html">mwDirectory</a> *dir, guint32 code, guint32 offset, GList *members)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Appropriate function signature for handling directory search results. <a href="#81dc6682023f70d8bf2e523fdf37e77e"></a><br></td></tr> <tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#1f72abe2e707f73a2b29ab1dda42c903">mwDirectoryMemberType</a> { <br> <a class="el" href="mw__srvc__dir_8h.html#1f72abe2e707f73a2b29ab1dda42c9034df8201340e66f52d8f90300bac9da36">mwDirectoryMember_USER</a> = 0x0000, <br> <a class="el" href="mw__srvc__dir_8h.html#1f72abe2e707f73a2b29ab1dda42c9032250ec76f552aa18e0e7a74f66573f67">mwDirectoryMember_GROUP</a> = 0x0001 <br> }</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#60044a1a52101f8cc5b9d6a3b7a4d801">mwDirectoryState</a> { <br> <a class="el" href="mw__srvc__dir_8h.html#60044a1a52101f8cc5b9d6a3b7a4d801a23fa4280674777515fdf7127a9994ec">mwDirectory_NEW</a>, <br> <a class="el" href="mw__srvc__dir_8h.html#60044a1a52101f8cc5b9d6a3b7a4d801e8e0e99d2620433b2d7caa87e4f8010a">mwDirectory_PENDING</a>, <br> <a class="el" href="mw__srvc__dir_8h.html#60044a1a52101f8cc5b9d6a3b7a4d8017dfd76f714ee09bc65c7c83ce3159fe8">mwDirectory_OPEN</a>, <br> <a class="el" href="mw__srvc__dir_8h.html#60044a1a52101f8cc5b9d6a3b7a4d80110be11afe4f1c5faaeee216827c556ae">mwDirectory_ERROR</a>, <br> <a class="el" href="mw__srvc__dir_8h.html#60044a1a52101f8cc5b9d6a3b7a4d80149f46e4de9c565c09de4db0a1cb6073f">mwDirectory_UNKNOWN</a> <br> }</td></tr> <tr><td colspan="2"><br><h2>Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">GList * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#d19477b511ad0a0240646eeaad26976c">mwAddressBook_getDirectories</a> (struct <a class="el" href="structmwAddressBook.html">mwAddressBook</a> *book)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">list of directories associated with address book. <a href="#d19477b511ad0a0240646eeaad26976c"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#9be5eacaa47c1b40a6d6e6865a50efb5">mwAddressBook_getName</a> (struct <a class="el" href="structmwAddressBook.html">mwAddressBook</a> *book)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">the name of the address book <a href="#9be5eacaa47c1b40a6d6e6865a50efb5"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#ee4a5d99e7505d038ce21f5014c8956e">mwDirectory_destroy</a> (struct <a class="el" href="structmwDirectory.html">mwDirectory</a> *dir)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">close and free the directory, and unassociate it with its owning address book and service <a href="#ee4a5d99e7505d038ce21f5014c8956e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwAddressBook.html">mwAddressBook</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#e6814f65378ee93bede00fc3189cc906">mwDirectory_getAddressBook</a> (struct <a class="el" href="structmwDirectory.html">mwDirectory</a> *dir)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">reference owning address book <a href="#e6814f65378ee93bede00fc3189cc906"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">gpointer </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#635923e640e1679a7e8ad72da82bd124">mwDirectory_getClientData</a> (struct <a class="el" href="structmwDirectory.html">mwDirectory</a> *dir)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">reference associated client data <a href="#635923e640e1679a7e8ad72da82bd124"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwServiceDirectory.html">mwServiceDirectory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#b1e972026a1b564187df0b94539ad496">mwDirectory_getService</a> (struct <a class="el" href="structmwDirectory.html">mwDirectory</a> *dir)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">reference owning service <a href="#b1e972026a1b564187df0b94539ad496"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">enum <a class="el" href="mw__srvc__dir_8h.html#60044a1a52101f8cc5b9d6a3b7a4d801">mwDirectoryState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#ac64837707b8912f6663943323fc2b91">mwDirectory_getState</a> (struct <a class="el" href="structmwDirectory.html">mwDirectory</a> *dir)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwDirectory.html">mwDirectory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#26725adc1b0a0e46f65e5b1fda318678">mwDirectory_new</a> (struct <a class="el" href="structmwAddressBook.html">mwAddressBook</a> *book)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">allocate a new directory based off the given address book <a href="#26725adc1b0a0e46f65e5b1fda318678"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#d48d6fefb1b5bc3b394f0cd1f705a355">mwDirectory_next</a> (struct <a class="el" href="structmwDirectory.html">mwDirectory</a> *dir)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">continue a search into its next results <a href="#d48d6fefb1b5bc3b394f0cd1f705a355"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#8b4c2367f50ad288b7a6902d7ea1d3d9">mwDirectory_open</a> (struct <a class="el" href="structmwDirectory.html">mwDirectory</a> *dir, <a class="el" href="mw__srvc__dir_8h.html#81dc6682023f70d8bf2e523fdf37e77e">mwSearchHandler</a> cb)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">initialize a directory. <a href="#8b4c2367f50ad288b7a6902d7ea1d3d9"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#f875cf16eb3af5c5ddcf2663f5cb4961">mwDirectory_previous</a> (struct <a class="el" href="structmwDirectory.html">mwDirectory</a> *dir)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">continue a search into its previous results <a href="#f875cf16eb3af5c5ddcf2663f5cb4961"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#2bdd0844643324c5aeaedff5762a9a24">mwDirectory_removeClientData</a> (struct <a class="el" href="structmwDirectory.html">mwDirectory</a> *dir)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">remove and cleanup user data <a href="#2bdd0844643324c5aeaedff5762a9a24"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#9dbd426e14906b932c49fc8bf73b05b3">mwDirectory_search</a> (struct <a class="el" href="structmwDirectory.html">mwDirectory</a> *dir, const char *query)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">initiate a search on an open directory <a href="#9dbd426e14906b932c49fc8bf73b05b3"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#c1f534a4ae485697d28607fb413f8adc">mwDirectory_setClientData</a> (struct <a class="el" href="structmwDirectory.html">mwDirectory</a> *dir, gpointer data, GDestroyNotify <a class="el" href="structmwService.html#9b86cc0545150a4fde3ab3060e803e58">clear</a>)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">set client data. <a href="#c1f534a4ae485697d28607fb413f8adc"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">GList * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#48dff54d4ac64af11d3108ca6d6881c0">mwServiceDirectory_getAddressBooks</a> (struct <a class="el" href="structmwServiceDirectory.html">mwServiceDirectory</a> *srvc)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">most recent list of address books available in service <a href="#48dff54d4ac64af11d3108ca6d6881c0"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">GList * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#1d42ec96164218c4c632bb75ae055fb9">mwServiceDirectory_getDirectories</a> (struct <a class="el" href="structmwServiceDirectory.html">mwServiceDirectory</a> *srvc)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">list of directories in the service <a href="#1d42ec96164218c4c632bb75ae055fb9"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwDirectoryHandler.html">mwDirectoryHandler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#dadae841da1783e2c0a9a52d862bfae3">mwServiceDirectory_getHandler</a> (struct <a class="el" href="structmwServiceDirectory.html">mwServiceDirectory</a> *srvc)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">the handler associated with the service at its creation <a href="#dadae841da1783e2c0a9a52d862bfae3"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwServiceDirectory.html">mwServiceDirectory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#0e56c0fb35eca0aaffcaee3faa53192a">mwServiceDirectory_new</a> (struct <a class="el" href="structmwSession.html">mwSession</a> *<a class="el" href="structmwService.html#0c2badd2256155b2bee149fa4b57b7d6">session</a>, struct <a class="el" href="structmwDirectoryHandler.html">mwDirectoryHandler</a> *handler)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate a new directory service instance for use with session. <a href="#0e56c0fb35eca0aaffcaee3faa53192a"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__dir_8h.html#29a526b9ae82e319c04ac7fb9890bc36">mwServiceDirectory_refreshAddressBooks</a> (struct <a class="el" href="structmwServiceDirectory.html">mwServiceDirectory</a> *srvc)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">submit a request to obtain an updated list of address books from service <a href="#29a526b9ae82e319c04ac7fb9890bc36"></a><br></td></tr> </table> <hr><h2>Define Documentation</h2> <a class="anchor" name="d14f85f7524da53701b6815b40bd3031"></a><!-- doxytag: member="mw_srvc_dir.h::_MW_SERV_DIR_H" ref="d14f85f7524da53701b6815b40bd3031" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define _MW_SERV_DIR_H </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="9e8e363d3e984cb248f780ecf7c669b7"></a><!-- doxytag: member="mw_srvc_dir.h::DIR_SEARCH_ERROR" ref="9e8e363d3e984cb248f780ecf7c669b7" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define DIR_SEARCH_ERROR 0x00000000 </td> </tr> </table> </div> <div class="memdoc"> <p> return value of directory searches that fail <p> </div> </div><p> <a class="anchor" name="3e71e58bfa721b29af1e8e6bea0c210d"></a><!-- doxytag: member="mw_srvc_dir.h::MW_DIRECTORY_IS_NEW" ref="3e71e58bfa721b29af1e8e6bea0c210d" args="(dir)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MW_DIRECTORY_IS_NEW </td> <td>(</td> <td class="paramtype">dir </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> MW_DIRECTORY_IS_STATE((dir), mwDirectory_NEW)</td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="59dee2af6e326396710262410a83727b"></a><!-- doxytag: member="mw_srvc_dir.h::MW_DIRECTORY_IS_OPEN" ref="59dee2af6e326396710262410a83727b" args="(dir)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MW_DIRECTORY_IS_OPEN </td> <td>(</td> <td class="paramtype">dir </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> MW_DIRECTORY_IS_STATE((dir), mwDirectory_OPEN)</td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="61b98cd6f71f89e50d37d1976c1b7e1f"></a><!-- doxytag: member="mw_srvc_dir.h::MW_DIRECTORY_IS_PENDING" ref="61b98cd6f71f89e50d37d1976c1b7e1f" args="(dir)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MW_DIRECTORY_IS_PENDING </td> <td>(</td> <td class="paramtype">dir </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> MW_DIRECTORY_IS_STATE((dir), mwDirectory_PENDING)</td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="31c29620bbcc76eed48040a16a7c0af1"></a><!-- doxytag: member="mw_srvc_dir.h::MW_DIRECTORY_IS_STATE" ref="31c29620bbcc76eed48040a16a7c0af1" args="(dir, state)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MW_DIRECTORY_IS_STATE </td> <td>(</td> <td class="paramtype">dir, <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structmwService.html#b5adc0f5a0cbeddaece7a4512ec66099">state</a> </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> (mwDirectory_getState(dir) == (<a class="el" href="structmwService.html#b5adc0f5a0cbeddaece7a4512ec66099">state</a>))</td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="e09f7e7e838b943ab68103d5be873cf6"></a><!-- doxytag: member="mw_srvc_dir.h::SERVICE_DIRECTORY" ref="e09f7e7e838b943ab68103d5be873cf6" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define SERVICE_DIRECTORY 0x0000001a </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr><h2>Typedef Documentation</h2> <a class="anchor" name="81dc6682023f70d8bf2e523fdf37e77e"></a><!-- doxytag: member="mw_srvc_dir.h::mwSearchHandler" ref="81dc6682023f70d8bf2e523fdf37e77e" args=")(struct mwDirectory *dir, guint32 code, guint32 offset, GList *members)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef void(* <a class="el" href="mw__srvc__dir_8h.html#81dc6682023f70d8bf2e523fdf37e77e">mwSearchHandler</a>)(struct <a class="el" href="structmwDirectory.html">mwDirectory</a> *dir, guint32 code, guint32 offset, GList *members) </td> </tr> </table> </div> <div class="memdoc"> <p> Appropriate function signature for handling directory search results. <p> </div> </div><p> <hr><h2>Enumeration Type Documentation</h2> <a class="anchor" name="1f72abe2e707f73a2b29ab1dda42c903"></a><!-- doxytag: member="mw_srvc_dir.h::mwDirectoryMemberType" ref="1f72abe2e707f73a2b29ab1dda42c903" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="mw__srvc__dir_8h.html#1f72abe2e707f73a2b29ab1dda42c903">mwDirectoryMemberType</a> </td> </tr> </table> </div> <div class="memdoc"> <p> <dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><em><a class="anchor" name="1f72abe2e707f73a2b29ab1dda42c9034df8201340e66f52d8f90300bac9da36"></a><!-- doxytag: member="mwDirectoryMember_USER" ref="1f72abe2e707f73a2b29ab1dda42c9034df8201340e66f52d8f90300bac9da36" args="" -->mwDirectoryMember_USER</em> </td><td> </td></tr> <tr><td valign="top"><em><a class="anchor" name="1f72abe2e707f73a2b29ab1dda42c9032250ec76f552aa18e0e7a74f66573f67"></a><!-- doxytag: member="mwDirectoryMember_GROUP" ref="1f72abe2e707f73a2b29ab1dda42c9032250ec76f552aa18e0e7a74f66573f67" args="" -->mwDirectoryMember_GROUP</em> </td><td> </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="60044a1a52101f8cc5b9d6a3b7a4d801"></a><!-- doxytag: member="mw_srvc_dir.h::mwDirectoryState" ref="60044a1a52101f8cc5b9d6a3b7a4d801" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="mw__srvc__dir_8h.html#60044a1a52101f8cc5b9d6a3b7a4d801">mwDirectoryState</a> </td> </tr> </table> </div> <div class="memdoc"> <p> <dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><em><a class="anchor" name="60044a1a52101f8cc5b9d6a3b7a4d801a23fa4280674777515fdf7127a9994ec"></a><!-- doxytag: member="mwDirectory_NEW" ref="60044a1a52101f8cc5b9d6a3b7a4d801a23fa4280674777515fdf7127a9994ec" args="" -->mwDirectory_NEW</em> </td><td> directory is created, but not open </td></tr> <tr><td valign="top"><em><a class="anchor" name="60044a1a52101f8cc5b9d6a3b7a4d801e8e0e99d2620433b2d7caa87e4f8010a"></a><!-- doxytag: member="mwDirectory_PENDING" ref="60044a1a52101f8cc5b9d6a3b7a4d801e8e0e99d2620433b2d7caa87e4f8010a" args="" -->mwDirectory_PENDING</em> </td><td> directory has in the process of opening </td></tr> <tr><td valign="top"><em><a class="anchor" name="60044a1a52101f8cc5b9d6a3b7a4d8017dfd76f714ee09bc65c7c83ce3159fe8"></a><!-- doxytag: member="mwDirectory_OPEN" ref="60044a1a52101f8cc5b9d6a3b7a4d8017dfd76f714ee09bc65c7c83ce3159fe8" args="" -->mwDirectory_OPEN</em> </td><td> directory is open </td></tr> <tr><td valign="top"><em><a class="anchor" name="60044a1a52101f8cc5b9d6a3b7a4d80110be11afe4f1c5faaeee216827c556ae"></a><!-- doxytag: member="mwDirectory_ERROR" ref="60044a1a52101f8cc5b9d6a3b7a4d80110be11afe4f1c5faaeee216827c556ae" args="" -->mwDirectory_ERROR</em> </td><td> error opening or using directory </td></tr> <tr><td valign="top"><em><a class="anchor" name="60044a1a52101f8cc5b9d6a3b7a4d80149f46e4de9c565c09de4db0a1cb6073f"></a><!-- doxytag: member="mwDirectory_UNKNOWN" ref="60044a1a52101f8cc5b9d6a3b7a4d80149f46e4de9c565c09de4db0a1cb6073f" args="" -->mwDirectory_UNKNOWN</em> </td><td> error determining directory state </td></tr> </table> </dl> </div> </div><p> <hr><h2>Function Documentation</h2> <a class="anchor" name="d19477b511ad0a0240646eeaad26976c"></a><!-- doxytag: member="mw_srvc_dir.h::mwAddressBook_getDirectories" ref="d19477b511ad0a0240646eeaad26976c" args="(struct mwAddressBook *book)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GList* mwAddressBook_getDirectories </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwAddressBook.html">mwAddressBook</a> * </td> <td class="paramname"> <em>book</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> list of directories associated with address book. <p> Note that the returned GList will need to be free'd after use </div> </div><p> <a class="anchor" name="9be5eacaa47c1b40a6d6e6865a50efb5"></a><!-- doxytag: member="mw_srvc_dir.h::mwAddressBook_getName" ref="9be5eacaa47c1b40a6d6e6865a50efb5" args="(struct mwAddressBook *book)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* mwAddressBook_getName </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwAddressBook.html">mwAddressBook</a> * </td> <td class="paramname"> <em>book</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> the name of the address book <p> </div> </div><p> <a class="anchor" name="ee4a5d99e7505d038ce21f5014c8956e"></a><!-- doxytag: member="mw_srvc_dir.h::mwDirectory_destroy" ref="ee4a5d99e7505d038ce21f5014c8956e" args="(struct mwDirectory *dir)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mwDirectory_destroy </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwDirectory.html">mwDirectory</a> * </td> <td class="paramname"> <em>dir</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> close and free the directory, and unassociate it with its owning address book and service <p> </div> </div><p> <a class="anchor" name="e6814f65378ee93bede00fc3189cc906"></a><!-- doxytag: member="mw_srvc_dir.h::mwDirectory_getAddressBook" ref="e6814f65378ee93bede00fc3189cc906" args="(struct mwDirectory *dir)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct <a class="el" href="structmwAddressBook.html">mwAddressBook</a>* mwDirectory_getAddressBook </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwDirectory.html">mwDirectory</a> * </td> <td class="paramname"> <em>dir</em> </td> <td> ) </td> <td width="100%"><code> [read]</code></td> </tr> </table> </div> <div class="memdoc"> <p> reference owning address book <p> </div> </div><p> <a class="anchor" name="635923e640e1679a7e8ad72da82bd124"></a><!-- doxytag: member="mw_srvc_dir.h::mwDirectory_getClientData" ref="635923e640e1679a7e8ad72da82bd124" args="(struct mwDirectory *dir)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gpointer mwDirectory_getClientData </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwDirectory.html">mwDirectory</a> * </td> <td class="paramname"> <em>dir</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> reference associated client data <p> </div> </div><p> <a class="anchor" name="b1e972026a1b564187df0b94539ad496"></a><!-- doxytag: member="mw_srvc_dir.h::mwDirectory_getService" ref="b1e972026a1b564187df0b94539ad496" args="(struct mwDirectory *dir)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct <a class="el" href="structmwServiceDirectory.html">mwServiceDirectory</a>* mwDirectory_getService </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwDirectory.html">mwDirectory</a> * </td> <td class="paramname"> <em>dir</em> </td> <td> ) </td> <td width="100%"><code> [read]</code></td> </tr> </table> </div> <div class="memdoc"> <p> reference owning service <p> </div> </div><p> <a class="anchor" name="ac64837707b8912f6663943323fc2b91"></a><!-- doxytag: member="mw_srvc_dir.h::mwDirectory_getState" ref="ac64837707b8912f6663943323fc2b91" args="(struct mwDirectory *dir)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="mw__srvc__dir_8h.html#60044a1a52101f8cc5b9d6a3b7a4d801">mwDirectoryState</a> mwDirectory_getState </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwDirectory.html">mwDirectory</a> * </td> <td class="paramname"> <em>dir</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="26725adc1b0a0e46f65e5b1fda318678"></a><!-- doxytag: member="mw_srvc_dir.h::mwDirectory_new" ref="26725adc1b0a0e46f65e5b1fda318678" args="(struct mwAddressBook *book)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct <a class="el" href="structmwDirectory.html">mwDirectory</a>* mwDirectory_new </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwAddressBook.html">mwAddressBook</a> * </td> <td class="paramname"> <em>book</em> </td> <td> ) </td> <td width="100%"><code> [read]</code></td> </tr> </table> </div> <div class="memdoc"> <p> allocate a new directory based off the given address book <p> </div> </div><p> <a class="anchor" name="d48d6fefb1b5bc3b394f0cd1f705a355"></a><!-- doxytag: member="mw_srvc_dir.h::mwDirectory_next" ref="d48d6fefb1b5bc3b394f0cd1f705a355" args="(struct mwDirectory *dir)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mwDirectory_next </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwDirectory.html">mwDirectory</a> * </td> <td class="paramname"> <em>dir</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> continue a search into its next results <p> </div> </div><p> <a class="anchor" name="8b4c2367f50ad288b7a6902d7ea1d3d9"></a><!-- doxytag: member="mw_srvc_dir.h::mwDirectory_open" ref="8b4c2367f50ad288b7a6902d7ea1d3d9" args="(struct mwDirectory *dir, mwSearchHandler cb)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mwDirectory_open </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwDirectory.html">mwDirectory</a> * </td> <td class="paramname"> <em>dir</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="mw__srvc__dir_8h.html#81dc6682023f70d8bf2e523fdf37e77e">mwSearchHandler</a> </td> <td class="paramname"> <em>cb</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> initialize a directory. <p> </div> </div><p> <a class="anchor" name="f875cf16eb3af5c5ddcf2663f5cb4961"></a><!-- doxytag: member="mw_srvc_dir.h::mwDirectory_previous" ref="f875cf16eb3af5c5ddcf2663f5cb4961" args="(struct mwDirectory *dir)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mwDirectory_previous </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwDirectory.html">mwDirectory</a> * </td> <td class="paramname"> <em>dir</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> continue a search into its previous results <p> </div> </div><p> <a class="anchor" name="2bdd0844643324c5aeaedff5762a9a24"></a><!-- doxytag: member="mw_srvc_dir.h::mwDirectory_removeClientData" ref="2bdd0844643324c5aeaedff5762a9a24" args="(struct mwDirectory *dir)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mwDirectory_removeClientData </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwDirectory.html">mwDirectory</a> * </td> <td class="paramname"> <em>dir</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> remove and cleanup user data <p> </div> </div><p> <a class="anchor" name="9dbd426e14906b932c49fc8bf73b05b3"></a><!-- doxytag: member="mw_srvc_dir.h::mwDirectory_search" ref="9dbd426e14906b932c49fc8bf73b05b3" args="(struct mwDirectory *dir, const char *query)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mwDirectory_search </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwDirectory.html">mwDirectory</a> * </td> <td class="paramname"> <em>dir</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>query</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> initiate a search on an open directory <p> </div> </div><p> <a class="anchor" name="c1f534a4ae485697d28607fb413f8adc"></a><!-- doxytag: member="mw_srvc_dir.h::mwDirectory_setClientData" ref="c1f534a4ae485697d28607fb413f8adc" args="(struct mwDirectory *dir, gpointer data, GDestroyNotify clear)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mwDirectory_setClientData </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwDirectory.html">mwDirectory</a> * </td> <td class="paramname"> <em>dir</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">gpointer </td> <td class="paramname"> <em>data</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">GDestroyNotify </td> <td class="paramname"> <em>clear</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> set client data. <p> If there is an existing clear function, it will not be called </div> </div><p> <a class="anchor" name="48dff54d4ac64af11d3108ca6d6881c0"></a><!-- doxytag: member="mw_srvc_dir.h::mwServiceDirectory_getAddressBooks" ref="48dff54d4ac64af11d3108ca6d6881c0" args="(struct mwServiceDirectory *srvc)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GList* mwServiceDirectory_getAddressBooks </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwServiceDirectory.html">mwServiceDirectory</a> * </td> <td class="paramname"> <em>srvc</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> most recent list of address books available in service <p> </div> </div><p> <a class="anchor" name="1d42ec96164218c4c632bb75ae055fb9"></a><!-- doxytag: member="mw_srvc_dir.h::mwServiceDirectory_getDirectories" ref="1d42ec96164218c4c632bb75ae055fb9" args="(struct mwServiceDirectory *srvc)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GList* mwServiceDirectory_getDirectories </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwServiceDirectory.html">mwServiceDirectory</a> * </td> <td class="paramname"> <em>srvc</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> list of directories in the service <p> </div> </div><p> <a class="anchor" name="dadae841da1783e2c0a9a52d862bfae3"></a><!-- doxytag: member="mw_srvc_dir.h::mwServiceDirectory_getHandler" ref="dadae841da1783e2c0a9a52d862bfae3" args="(struct mwServiceDirectory *srvc)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct <a class="el" href="structmwDirectoryHandler.html">mwDirectoryHandler</a>* mwServiceDirectory_getHandler </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwServiceDirectory.html">mwServiceDirectory</a> * </td> <td class="paramname"> <em>srvc</em> </td> <td> ) </td> <td width="100%"><code> [read]</code></td> </tr> </table> </div> <div class="memdoc"> <p> the handler associated with the service at its creation <p> </div> </div><p> <a class="anchor" name="0e56c0fb35eca0aaffcaee3faa53192a"></a><!-- doxytag: member="mw_srvc_dir.h::mwServiceDirectory_new" ref="0e56c0fb35eca0aaffcaee3faa53192a" args="(struct mwSession *session, struct mwDirectoryHandler *handler)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct <a class="el" href="structmwServiceDirectory.html">mwServiceDirectory</a>* mwServiceDirectory_new </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwSession.html">mwSession</a> * </td> <td class="paramname"> <em>session</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">struct <a class="el" href="structmwDirectoryHandler.html">mwDirectoryHandler</a> * </td> <td class="paramname"> <em>handler</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [read]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Allocate a new directory service instance for use with session. <p> </div> </div><p> <a class="anchor" name="29a526b9ae82e319c04ac7fb9890bc36"></a><!-- doxytag: member="mw_srvc_dir.h::mwServiceDirectory_refreshAddressBooks" ref="29a526b9ae82e319c04ac7fb9890bc36" args="(struct mwServiceDirectory *srvc)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int mwServiceDirectory_refreshAddressBooks </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structmwServiceDirectory.html">mwServiceDirectory</a> * </td> <td class="paramname"> <em>srvc</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> submit a request to obtain an updated list of address books from service <p> </div> </div><p> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Dec 19 09:10:34 2007 for meanwhile by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address> </body> </html>