<html> <head> <title>MAPIClientLibraries 0.8 API Documentation</title> <link href="doxygen.css" rel="stylesheet" type="text/css"/> <link href="apidocs.css" rel="stylesheet" type="text/css"/> </head> <body> <div id="website"> <div class="header"></div> <div id="middle_side"> <div id="right_side_home"> <!-- Generated by Doxygen 1.5.9 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> </div> <div class="contents"> <h1>libmapi/IXPLogon.c File Reference</h1>Transport provider status information. <a href="#_details">More...</a> <p> <code>#include <libmapi/libmapi.h></code><br> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="IXPLogon_8c.html#c8e9a3a3c1f5cf14e3c27c8ae5b2e308">AddressTypes</a> (mapi_object_t *obj_store, uint16_t *lpcAdrType, struct mapi_LPSTR **lpAdrTypeArray)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="IXPLogon_8c.html#d1dfbf01a4d1415731e8c38308859b75">SetSpooler</a> (mapi_object_t *obj_store)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="IXPLogon_8c.html#960c9dc4cf4c0736d9471724511a256d">SpoolerLockMessage</a> (mapi_object_t *obj_store, mapi_object_t *obj_message, uint8_t LockState)</td></tr> </table> <hr><h2>Detailed Description</h2> Transport provider status information. <p> <hr><h2>Function Documentation</h2> <a class="anchor" name="c8e9a3a3c1f5cf14e3c27c8ae5b2e308"></a><!-- doxytag: member="IXPLogon.c::AddressTypes" ref="c8e9a3a3c1f5cf14e3c27c8ae5b2e308" args="(mapi_object_t *obj_store, uint16_t *lpcAdrType, struct mapi_LPSTR **lpAdrTypeArray)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">_PUBLIC_ enum MAPISTATUS AddressTypes </td> <td>(</td> <td class="paramtype">mapi_object_t * </td> <td class="paramname"> <em>obj_store</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint16_t * </td> <td class="paramname"> <em>lpcAdrType</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">struct mapi_LPSTR ** </td> <td class="paramname"> <em>lpAdrTypeArray</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> Returns the types of recipients that the transport provider handles.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>obj_store</em> </td><td>the object to get recipients types from </td></tr> <tr><td valign="top"></td><td valign="top"><em>lpcAdrType</em> </td><td>the count of recipients types returned </td></tr> <tr><td valign="top"></td><td valign="top"><em>lpAdrTypeArray</em> </td><td>pointer on pointer of returned transport provider types</td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl> <dl class="note" compact><dt><b>Note:</b></dt><dd>Developers may also call <a class="el" href="IUnknown_8c.html#8237c7fc76377cb07f3f55920d6f20de">GetLastError()</a> to retrieve the last MAPI error code. Possible MAPI error codes are:<ul> <li>MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized</li><li>MAPI_E_INVALID_PARAMETER: obj_store is not initialized</li><li>MAPI_E_CALL_FAILED: A network problem was encountered during the transaction </li></ul> </dd></dl> <p>References <a class="el" href="emsmdb_8c_source.html#l00283">emsmdb_transaction()</a>, <a class="el" href="mapi__object_8c_source.html#l00264">mapi_object_get_handle()</a>, <a class="el" href="mapi__object_8c_source.html#l00238">mapi_object_get_logon_id()</a>, and <a class="el" href="mapi__object_8c_source.html#l00165">mapi_object_get_session()</a>.</p> </div> </div><p> <a class="anchor" name="d1dfbf01a4d1415731e8c38308859b75"></a><!-- doxytag: member="IXPLogon.c::SetSpooler" ref="d1dfbf01a4d1415731e8c38308859b75" args="(mapi_object_t *obj_store)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">_PUBLIC_ enum MAPISTATUS SetSpooler </td> <td>(</td> <td class="paramtype">mapi_object_t * </td> <td class="paramname"> <em>obj_store</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Informs the server that the client intends to act as a mail spooler.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>obj_store,:</em> </td><td>the object server store object</td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl> <dl class="note" compact><dt><b>Note:</b></dt><dd>Developers may also call <a class="el" href="IUnknown_8c.html#8237c7fc76377cb07f3f55920d6f20de">GetLastError()</a> to retrieve the last MAPI error code. Possible MAPI error codes are:<ul> <li>MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized</li><li>MAPI_E_INVALID_PARAMETER: obj_store is not initialized</li><li>MAPI_E_CALL_FAILED: A network problem was encountered during the transaction</li></ul> </dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="IXPLogon_8c.html#960c9dc4cf4c0736d9471724511a256d">SpoolerLockMessage</a> </dd></dl> <p>References <a class="el" href="emsmdb_8c_source.html#l00283">emsmdb_transaction()</a>, <a class="el" href="mapi__object_8c_source.html#l00264">mapi_object_get_handle()</a>, <a class="el" href="mapi__object_8c_source.html#l00238">mapi_object_get_logon_id()</a>, and <a class="el" href="mapi__object_8c_source.html#l00165">mapi_object_get_session()</a>.</p> </div> </div><p> <a class="anchor" name="960c9dc4cf4c0736d9471724511a256d"></a><!-- doxytag: member="IXPLogon.c::SpoolerLockMessage" ref="960c9dc4cf4c0736d9471724511a256d" args="(mapi_object_t *obj_store, mapi_object_t *obj_message, uint8_t LockState)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">_PUBLIC_ enum MAPISTATUS SpoolerLockMessage </td> <td>(</td> <td class="paramtype">mapi_object_t * </td> <td class="paramname"> <em>obj_store</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">mapi_object_t * </td> <td class="paramname"> <em>obj_message</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint8_t </td> <td class="paramname"> <em>LockState</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> Locks the specified message for spooling.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>obj_store</em> </td><td>the store object </td></tr> <tr><td valign="top"></td><td valign="top"><em>obj_message</em> </td><td>the message object we want to lock </td></tr> <tr><td valign="top"></td><td valign="top"><em>LockState</em> </td><td>the lock state</td></tr> </table> </dl> Possible values for the lock state:<ol type=1> <li>LockState_1stLock (0x0): Mark the message as locked</li><li>LockState_1stUnlock (0x1): Mark the message as unlocked</li><li>LockState_1stFinished (0x2): Mark the message as ready for processing by the server</li></ol> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl> <dl class="note" compact><dt><b>Note:</b></dt><dd>Developers may also call <a class="el" href="IUnknown_8c.html#8237c7fc76377cb07f3f55920d6f20de">GetLastError()</a> to retrieve the last MAPI error code. Possible MAPI error codes are:<ul> <li>MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized</li><li>MAPI_E_INVALID_PARAMETER: obj_store is not initialized</li><li>MAPI_E_CALL_FAILED: A network problem was encountered during the transaction</li></ul> </dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd>SetSPooler </dd></dl> <p>References <a class="el" href="emsmdb_8c_source.html#l00283">emsmdb_transaction()</a>, <a class="el" href="mapi__object_8c_source.html#l00264">mapi_object_get_handle()</a>, <a class="el" href="mapi__object_8c_source.html#l00197">mapi_object_get_id()</a>, <a class="el" href="mapi__object_8c_source.html#l00238">mapi_object_get_logon_id()</a>, and <a class="el" href="mapi__object_8c_source.html#l00165">mapi_object_get_session()</a>.</p> </div> </div><p> </div> </div> <br/> <table style="clear:both; margin: 0.5em auto; width:80%; text-align: center; background-color:#f8f8f8; border:2px solid #e0e0e0; padding:5px;"> <tr> <td> <img alt="Creative Commons License" src="CC_SomeRightsReserved.png" width="90" height="30" border="0" /><br /> <img alt="Creative Commons Attribution icon" src="24px-Cc-by_white.svg.png" width="24" height="24" border="0" /> <img alt="Creative Commons Share Alike icon" src="24px-Cc-sa_white.svg.png" width="24" height="24" border="0" /> </td> <td> <i><strong class="selflink">This content</strong> is licensed under the Creative Commons<br /> Attribution ShareAlike License v. 3.0:<br /> <a href="http://creativecommons.org/licenses/by-sa/3.0/" class="external free" title="http://creativecommons.org/licenses/by-sa/3.0/" rel="nofollow">http://creativecommons.org/licenses/by-sa/3.0/</a></i> </td></tr></table> <br/> </div> </div> </body> </html>