<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/mapi_object.c File Reference</h1>mapi_object_t support functions
<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>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5fdc7facea201bfce4ad308105f88d0c"></a><!-- doxytag: member="mapi_object.c::INVALID_HANDLE_VALUE" ref="5fdc7facea201bfce4ad308105f88d0c" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#5fdc7facea201bfce4ad308105f88d0c">INVALID_HANDLE_VALUE</a> 0xffffffff</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">keep intern to this file <br></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="mapi__object_8c.html#696fc653219d446271c85fffc100e157">mapi_object_bookmark_debug</a> (mapi_object_t *obj_table)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#ede7db5a93dc819adc88cb4392a3314b">mapi_object_bookmark_find</a> (mapi_object_t *obj_table, uint32_t bkPosition, struct SBinary_short *bin)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#6ae3b6b354ffa1ec70b92e3e6dcfd86f">mapi_object_bookmark_get_count</a> (mapi_object_t *obj_table, uint32_t *count)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#6f2f8a23b373d094c8e5606e1be50262">mapi_object_copy</a> (mapi_object_t *dst, mapi_object_t *src)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ void </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#88326d52d8779ddfa64a3603fcf4828a">mapi_object_debug</a> (mapi_object_t *obj)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">mapi_handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#a94645f34e6c4bf1c0631dffb0742676">mapi_object_get_handle</a> (mapi_object_t *obj)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ mapi_id_t </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#d4477e1e7c6dd8314638a9886b570209">mapi_object_get_id</a> (mapi_object_t *obj)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#d9729719d6310af3412ebd37e4d64dca">mapi_object_get_logon_id</a> (mapi_object_t *obj)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ struct mapi_session * </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#e5ef3137838fbc0c3eaedd7da99f8adc">mapi_object_get_session</a> (mapi_object_t *obj)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#f49c3130b8cb47f741ff652fc53c1364">mapi_object_init</a> (mapi_object_t *obj)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#3a4550bbdf5094863d579c3e74aa170f">mapi_object_is_invalid</a> (mapi_object_t *obj)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ void </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#de2b4701fae8a110c476b894834831b9">mapi_object_release</a> (mapi_object_t *obj)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#6cad283dc5a1228734e816adb30aa53c">mapi_object_set_handle</a> (mapi_object_t *obj, mapi_handle_t handle)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#87947ae1569ed162473811bb257922cb">mapi_object_set_id</a> (mapi_object_t *obj, mapi_id_t id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ void </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#845af67422945480121797b8a44ab14d">mapi_object_set_logon_id</a> (mapi_object_t *obj, uint8_t logon_id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ void </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#5ae14832b40db995554d07a2bbdb59fd">mapi_object_set_logon_store</a> (mapi_object_t *obj)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ void </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#373e9bd46155ea22e816fa66944f22a6">mapi_object_set_session</a> (mapi_object_t *obj, struct mapi_session *session)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__object_8c.html#678facb39f5979fec7ad08f2659d5181">mapi_object_table_init</a> (TALLOC_CTX *mem_ctx, mapi_object_t *obj_table)</td></tr>
</table>
<hr><h2>Detailed Description</h2>
mapi_object_t support functions
<p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="696fc653219d446271c85fffc100e157"></a><!-- doxytag: member="mapi_object.c::mapi_object_bookmark_debug" ref="696fc653219d446271c85fffc100e157" args="(mapi_object_t *obj_table)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS mapi_object_bookmark_debug </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj_table</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Dump bookmarks associated to a MAPI object table<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_table</em> </td><td>pointer on the MAPI object table</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ede7db5a93dc819adc88cb4392a3314b"></a><!-- doxytag: member="mapi_object.c::mapi_object_bookmark_find" ref="ede7db5a93dc819adc88cb4392a3314b" args="(mapi_object_t *obj_table, uint32_t bkPosition, struct SBinary_short *bin)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum MAPISTATUS mapi_object_bookmark_find </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>bkPosition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct SBinary_short * </td>
<td class="paramname"> <em>bin</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fetch a bookmark within a MAPI object table<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_table</em> </td><td>pointer on the MAPI object table </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bkPosition</em> </td><td>the bookmark position to find </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bin</em> </td><td>pointer on the Sbinary_short the function fills</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error. </dd></dl>
<p>Referenced by <a class="el" href="IMAPITable_8c_source.html#l01215">FindRow()</a>, and <a class="el" href="IMAPITable_8c_source.html#l00504">SeekRowBookmark()</a>.</p>
</div>
</div><p>
<a class="anchor" name="6ae3b6b354ffa1ec70b92e3e6dcfd86f"></a><!-- doxytag: member="mapi_object.c::mapi_object_bookmark_get_count" ref="6ae3b6b354ffa1ec70b92e3e6dcfd86f" args="(mapi_object_t *obj_table, uint32_t *count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS mapi_object_bookmark_get_count </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t * </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the number of bookmarks stored in a MAPI object table<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_table</em> </td><td>pointer to the MAPI object table </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>pointer to the number of bookmarks to return</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error. </dd></dl>
</div>
</div><p>
<a class="anchor" name="6f2f8a23b373d094c8e5606e1be50262"></a><!-- doxytag: member="mapi_object.c::mapi_object_copy" ref="6f2f8a23b373d094c8e5606e1be50262" args="(mapi_object_t *dst, mapi_object_t *src)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS mapi_object_copy </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>src</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy MAPI object<p>
This function copies mapi_object data from source to destination.<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>dst</em> </td><td>pointer on the destination MAPI object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>pointer on the source MAPI object</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI_E_NOT_INITIALIZED </dd></dl>
</div>
</div><p>
<a class="anchor" name="88326d52d8779ddfa64a3603fcf4828a"></a><!-- doxytag: member="mapi_object.c::mapi_object_debug" ref="88326d52d8779ddfa64a3603fcf4828a" args="(mapi_object_t *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ void mapi_object_debug </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Dump a MAPI object (for debugging)<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</em> </td><td>pointer on the MAPI object to dump out </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a94645f34e6c4bf1c0631dffb0742676"></a><!-- doxytag: member="mapi_object.c::mapi_object_get_handle" ref="a94645f34e6c4bf1c0631dffb0742676" args="(mapi_object_t *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mapi_handle_t mapi_object_get_handle </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the handle associated to a MAPI object<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</em> </td><td>pointer on the MAPI object to retrieve the handle from</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a valid MAPI object handle on success, otherwise -1. </dd></dl>
<p>Referenced by <a class="el" href="IMAPITable_8c_source.html#l01410">Abort()</a>, <a class="el" href="IMessage_8c_source.html#l00994">AbortSubmit()</a>, <a class="el" href="IXPLogon_8c_source.html#l00050">AddressTypes()</a>, <a class="el" href="IStream_8c_source.html#l00902">CloneStream()</a>, <a class="el" href="IMAPITable_8c_source.html#l01609">CollapseRow()</a>, <a class="el" href="IStream_8c_source.html#l00340">CommitStream()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l01020">CopyFolder()</a>, <a class="el" href="IMAPIProp_8c_source.html#l01144">CopyProps()</a>, <a class="el" href="IMAPIProp_8c_source.html#l01260">CopyTo()</a>, <a class="el" href="IStream_8c_source.html#l00650">CopyToStream()</a>, <a class="el" href="IMessage_8c_source.html#l00077">CreateAttach()</a>, <a class="el" href="IMAPITable_8c_source.html#l00689">CreateBookmark()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00597">CreateFolder()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00048">CreateMessage()</a>, <a class="el" href="IMessage_8c_source.html#l00162">DeleteAttach()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00824">DeleteFolder()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00139">DeleteMessage()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00734">DeletePropertiesNoReplicate()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00544">DeleteProps()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00739">EmptyFolder()</a>, <a class="el" href="IMAPITable_8c_source.html#l01505">ExpandRow()</a>, <a class="el" href="IMAPITable_8c_source.html#l01215">FindRow()</a>, <a class="el" href="IMAPITable_8c_source.html#l00782">FreeBookmark()</a>, <a class="el" href="IMessage_8c_source.html#l00234">GetAttachmentTable()</a>, <a class="el" href="IMAPITable_8c_source.html#l01700">GetCollapseState()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00081">GetContentsTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00207">GetHierarchyTable()</a>, <a class="el" href="IUnknown_8c_source.html#l00276">GetIdFromLongTermId()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00922">GetIDsFromNames()</a>, <a class="el" href="FXICS_8c_source.html#l00051">GetLocalReplicaIds()</a>, <a class="el" href="IUnknown_8c_source.html#l00192">GetLongTermIdFromId()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00303">GetMessageStatus()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00818">GetNamesFromIDs()</a>, <a class="el" href="IMsgStore_8c_source.html#l00661">GetOwningServers()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00379">GetPropList()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00059">GetProps()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00464">GetPropsAll()</a>, <a class="el" href="IMsgStore_8c_source.html#l00396">GetReceiveFolder()</a>, <a class="el" href="IMsgStore_8c_source.html#l00483">GetReceiveFolderTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00395">GetRulesTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00704">GetSearchCriteria()</a>, <a class="el" href="IMAPITable_8c_source.html#l01337">GetStatus()</a>, <a class="el" href="IMsgStore_8c_source.html#l00768">GetStoreState()</a>, <a class="el" href="IStream_8c_source.html#l00408">GetStreamSize()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00303">GetTable()</a>, <a class="el" href="IMsgStore_8c_source.html#l00582">GetTransportFolder()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00223">HardDeleteMessage()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l01222">HardDeleteMessagesAndSubfolders()</a>, <a class="el" href="IStream_8c_source.html#l00748">LockRegionStream()</a>, <a class="el" href="mapi__object_8c_source.html#l00121">mapi_object_is_invalid()</a>, <a class="el" href="IMessage_8c_source.html#l00529">ModifyRecipients()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00493">ModifyTable()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00489">MoveCopyMessages()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00912">MoveFolder()</a>, <a class="el" href="IMessage_8c_source.html#l00324">OpenAttach()</a>, <a class="el" href="IMessage_8c_source.html#l01408">OpenEmbeddedMessage()</a>, <a class="el" href="IMsgStore_8c_source.html#l00048">OpenFolder()</a>, <a class="el" href="IStoreFolder_8c_source.html#l00061">OpenMessage()</a>, <a class="el" href="IMsgStore_8c_source.html#l00219">OpenPublicFolderByName()</a>, <a class="el" href="IStream_8c_source.html#l00063">OpenStream()</a>, <a class="el" href="IMsgStore_8c_source.html#l00133">PublicFolderIsGhosted()</a>, <a class="el" href="IMAPITable_8c_source.html#l00325">QueryColumns()</a>, <a class="el" href="IMAPIProp_8c_source.html#l01035">QueryNamedProperties()</a>, <a class="el" href="IMAPITable_8c_source.html#l00147">QueryPosition()</a>, <a class="el" href="IMAPITable_8c_source.html#l00233">QueryRows()</a>, <a class="el" href="IMessage_8c_source.html#l00753">ReadRecipients()</a>, <a class="el" href="IStream_8c_source.html#l00164">ReadStream()</a>, <a class="el" href="IUnknown_8c_source.html#l00112">Release()</a>, <a class="el" href="IMessage_8c_source.html#l00836">RemoveAllRecipients()</a>, <a class="el" href="IMAPITable_8c_source.html#l01026">Reset()</a>, <a class="el" href="IMAPITable_8c_source.html#l01111">Restrict()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00295">SaveChangesAttachment()</a>, <a class="el" href="IMessage_8c_source.html#l01084">SaveChangesMessage()</a>, <a class="el" href="IMAPITable_8c_source.html#l00414">SeekRow()</a>, <a class="el" href="IMAPITable_8c_source.html#l00609">SeekRowApprox()</a>, <a class="el" href="IMAPITable_8c_source.html#l00504">SeekRowBookmark()</a>, <a class="el" href="IStream_8c_source.html#l00489">SeekStream()</a>, <a class="el" href="IMAPITable_8c_source.html#l01791">SetCollapseState()</a>, <a class="el" href="IMAPITable_8c_source.html#l00051">SetColumns()</a>, <a class="el" href="IMessage_8c_source.html#l01276">SetMessageReadFlag()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00397">SetMessageStatus()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00627">SetPropertiesNoReplicate()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00181">SetProps()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l01136">SetReadFlags()</a>, <a class="el" href="IMsgStore_8c_source.html#l00310">SetReceiveFolder()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00605">SetSearchCriteria()</a>, <a class="el" href="IXPLogon_8c_source.html#l00125">SetSpooler()</a>, <a class="el" href="IStream_8c_source.html#l00570">SetStreamSize()</a>, <a class="el" href="IMAPITable_8c_source.html#l00880">SortTable()</a>, <a class="el" href="IXPLogon_8c_source.html#l00199">SpoolerLockMessage()</a>, <a class="el" href="IMessage_8c_source.html#l00913">SubmitMessage()</a>, <a class="el" href="IMAPISupport_8c_source.html#l00073">Subscribe()</a>, <a class="el" href="IMsgStore_8c_source.html#l00876">TransportNewMail()</a>, <a class="el" href="IMessage_8c_source.html#l01159">TransportSend()</a>, <a class="el" href="IStream_8c_source.html#l00827">UnlockRegionStream()</a>, <a class="el" href="IStream_8c_source.html#l00994">WriteAndCommitStream()</a>, and <a class="el" href="IStream_8c_source.html#l00260">WriteStream()</a>.</p>
</div>
</div><p>
<a class="anchor" name="d4477e1e7c6dd8314638a9886b570209"></a><!-- doxytag: member="mapi_object.c::mapi_object_get_id" ref="d4477e1e7c6dd8314638a9886b570209" args="(mapi_object_t *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ mapi_id_t mapi_object_get_id </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve an object ID for a given MAPI object<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</em> </td><td>pointer on the MAPI object to get the ID for</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the object ID, or -1 if the object does not exist </dd></dl>
<p>Referenced by <a class="el" href="IMessage_8c_source.html#l00994">AbortSubmit()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l01020">CopyFolder()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00048">CreateMessage()</a>, <a class="el" href="IMsgStore_8c_source.html#l00661">GetOwningServers()</a>, <a class="el" href="mapi__id__array_8c_source.html#l00156">mapi_id_array_add_obj()</a>, <a class="el" href="mapi__id__array_8c_source.html#l00272">mapi_id_array_del_obj()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00912">MoveFolder()</a>, <a class="el" href="IMsgStore_8c_source.html#l00133">PublicFolderIsGhosted()</a>, <a class="el" href="IMsgStore_8c_source.html#l00310">SetReceiveFolder()</a>, <a class="el" href="IXPLogon_8c_source.html#l00199">SpoolerLockMessage()</a>, <a class="el" href="IMAPISupport_8c_source.html#l00073">Subscribe()</a>, and <a class="el" href="IMsgStore_8c_source.html#l00876">TransportNewMail()</a>.</p>
</div>
</div><p>
<a class="anchor" name="d9729719d6310af3412ebd37e4d64dca"></a><!-- doxytag: member="mapi_object.c::mapi_object_get_logon_id" ref="d9729719d6310af3412ebd37e4d64dca" args="(mapi_object_t *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ uint8_t mapi_object_get_logon_id </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the logon id for a given MAPI object<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</em> </td><td>pointer to the object to retrieve the logon id from</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the object logon ID on success, otherwise -1 </dd></dl>
<p>Referenced by <a class="el" href="IMAPITable_8c_source.html#l01410">Abort()</a>, <a class="el" href="IMessage_8c_source.html#l00994">AbortSubmit()</a>, <a class="el" href="IXPLogon_8c_source.html#l00050">AddressTypes()</a>, <a class="el" href="IStream_8c_source.html#l00902">CloneStream()</a>, <a class="el" href="IMAPITable_8c_source.html#l01609">CollapseRow()</a>, <a class="el" href="IStream_8c_source.html#l00340">CommitStream()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l01020">CopyFolder()</a>, <a class="el" href="IMAPIProp_8c_source.html#l01144">CopyProps()</a>, <a class="el" href="IMAPIProp_8c_source.html#l01260">CopyTo()</a>, <a class="el" href="IStream_8c_source.html#l00650">CopyToStream()</a>, <a class="el" href="IMessage_8c_source.html#l00077">CreateAttach()</a>, <a class="el" href="IMAPITable_8c_source.html#l00689">CreateBookmark()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00597">CreateFolder()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00048">CreateMessage()</a>, <a class="el" href="IMessage_8c_source.html#l00162">DeleteAttach()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00824">DeleteFolder()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00139">DeleteMessage()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00734">DeletePropertiesNoReplicate()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00544">DeleteProps()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00739">EmptyFolder()</a>, <a class="el" href="IMAPITable_8c_source.html#l01505">ExpandRow()</a>, <a class="el" href="IMAPITable_8c_source.html#l01215">FindRow()</a>, <a class="el" href="IMAPITable_8c_source.html#l00782">FreeBookmark()</a>, <a class="el" href="IMessage_8c_source.html#l00234">GetAttachmentTable()</a>, <a class="el" href="IMAPITable_8c_source.html#l01700">GetCollapseState()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00081">GetContentsTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00207">GetHierarchyTable()</a>, <a class="el" href="IUnknown_8c_source.html#l00276">GetIdFromLongTermId()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00922">GetIDsFromNames()</a>, <a class="el" href="FXICS_8c_source.html#l00051">GetLocalReplicaIds()</a>, <a class="el" href="IUnknown_8c_source.html#l00192">GetLongTermIdFromId()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00303">GetMessageStatus()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00818">GetNamesFromIDs()</a>, <a class="el" href="IMsgStore_8c_source.html#l00661">GetOwningServers()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00379">GetPropList()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00059">GetProps()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00464">GetPropsAll()</a>, <a class="el" href="IMsgStore_8c_source.html#l00396">GetReceiveFolder()</a>, <a class="el" href="IMsgStore_8c_source.html#l00483">GetReceiveFolderTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00395">GetRulesTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00704">GetSearchCriteria()</a>, <a class="el" href="IMAPITable_8c_source.html#l01337">GetStatus()</a>, <a class="el" href="IMsgStore_8c_source.html#l00768">GetStoreState()</a>, <a class="el" href="IStream_8c_source.html#l00408">GetStreamSize()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00303">GetTable()</a>, <a class="el" href="IMsgStore_8c_source.html#l00582">GetTransportFolder()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00223">HardDeleteMessage()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l01222">HardDeleteMessagesAndSubfolders()</a>, <a class="el" href="IStream_8c_source.html#l00748">LockRegionStream()</a>, <a class="el" href="IMessage_8c_source.html#l00529">ModifyRecipients()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00493">ModifyTable()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00489">MoveCopyMessages()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00912">MoveFolder()</a>, <a class="el" href="IMessage_8c_source.html#l00324">OpenAttach()</a>, <a class="el" href="IMessage_8c_source.html#l01408">OpenEmbeddedMessage()</a>, <a class="el" href="IMsgStore_8c_source.html#l00048">OpenFolder()</a>, <a class="el" href="IStoreFolder_8c_source.html#l00061">OpenMessage()</a>, <a class="el" href="IMsgStore_8c_source.html#l00219">OpenPublicFolderByName()</a>, <a class="el" href="IStream_8c_source.html#l00063">OpenStream()</a>, <a class="el" href="IMsgStore_8c_source.html#l00133">PublicFolderIsGhosted()</a>, <a class="el" href="IMAPITable_8c_source.html#l00325">QueryColumns()</a>, <a class="el" href="IMAPIProp_8c_source.html#l01035">QueryNamedProperties()</a>, <a class="el" href="IMAPITable_8c_source.html#l00147">QueryPosition()</a>, <a class="el" href="IMAPITable_8c_source.html#l00233">QueryRows()</a>, <a class="el" href="IMessage_8c_source.html#l00753">ReadRecipients()</a>, <a class="el" href="IStream_8c_source.html#l00164">ReadStream()</a>, <a class="el" href="IUnknown_8c_source.html#l00112">Release()</a>, <a class="el" href="IMessage_8c_source.html#l00836">RemoveAllRecipients()</a>, <a class="el" href="IMAPITable_8c_source.html#l01026">Reset()</a>, <a class="el" href="IMAPITable_8c_source.html#l01111">Restrict()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00295">SaveChangesAttachment()</a>, <a class="el" href="IMessage_8c_source.html#l01084">SaveChangesMessage()</a>, <a class="el" href="IMAPITable_8c_source.html#l00414">SeekRow()</a>, <a class="el" href="IMAPITable_8c_source.html#l00609">SeekRowApprox()</a>, <a class="el" href="IMAPITable_8c_source.html#l00504">SeekRowBookmark()</a>, <a class="el" href="IStream_8c_source.html#l00489">SeekStream()</a>, <a class="el" href="IMAPITable_8c_source.html#l01791">SetCollapseState()</a>, <a class="el" href="IMAPITable_8c_source.html#l00051">SetColumns()</a>, <a class="el" href="IMessage_8c_source.html#l01276">SetMessageReadFlag()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00397">SetMessageStatus()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00627">SetPropertiesNoReplicate()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00181">SetProps()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l01136">SetReadFlags()</a>, <a class="el" href="IMsgStore_8c_source.html#l00310">SetReceiveFolder()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00605">SetSearchCriteria()</a>, <a class="el" href="IXPLogon_8c_source.html#l00125">SetSpooler()</a>, <a class="el" href="IStream_8c_source.html#l00570">SetStreamSize()</a>, <a class="el" href="IMAPITable_8c_source.html#l00880">SortTable()</a>, <a class="el" href="IXPLogon_8c_source.html#l00199">SpoolerLockMessage()</a>, <a class="el" href="IMessage_8c_source.html#l00913">SubmitMessage()</a>, <a class="el" href="IMAPISupport_8c_source.html#l00073">Subscribe()</a>, <a class="el" href="IMsgStore_8c_source.html#l00876">TransportNewMail()</a>, <a class="el" href="IMessage_8c_source.html#l01159">TransportSend()</a>, <a class="el" href="IStream_8c_source.html#l00827">UnlockRegionStream()</a>, <a class="el" href="IStream_8c_source.html#l00994">WriteAndCommitStream()</a>, and <a class="el" href="IStream_8c_source.html#l00260">WriteStream()</a>.</p>
</div>
</div><p>
<a class="anchor" name="e5ef3137838fbc0c3eaedd7da99f8adc"></a><!-- doxytag: member="mapi_object.c::mapi_object_get_session" ref="e5ef3137838fbc0c3eaedd7da99f8adc" args="(mapi_object_t *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ struct mapi_session* mapi_object_get_session </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj</em> </td>
<td> ) </td>
<td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the session associated to the MAPI object<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</em> </td><td>the object to get the session for</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer on a MAPI session on success, otherwise NULL </dd></dl>
<p>Referenced by <a class="el" href="IMAPITable_8c_source.html#l01410">Abort()</a>, <a class="el" href="IMessage_8c_source.html#l00994">AbortSubmit()</a>, <a class="el" href="IXPLogon_8c_source.html#l00050">AddressTypes()</a>, <a class="el" href="simple__mapi_8c_source.html#l00461">AddUserPermission()</a>, <a class="el" href="IStream_8c_source.html#l00902">CloneStream()</a>, <a class="el" href="IMAPITable_8c_source.html#l01609">CollapseRow()</a>, <a class="el" href="IStream_8c_source.html#l00340">CommitStream()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l01020">CopyFolder()</a>, <a class="el" href="IMAPIProp_8c_source.html#l01144">CopyProps()</a>, <a class="el" href="IMAPIProp_8c_source.html#l01260">CopyTo()</a>, <a class="el" href="IStream_8c_source.html#l00650">CopyToStream()</a>, <a class="el" href="IMessage_8c_source.html#l00077">CreateAttach()</a>, <a class="el" href="IMAPITable_8c_source.html#l00689">CreateBookmark()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00597">CreateFolder()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00048">CreateMessage()</a>, <a class="el" href="IMessage_8c_source.html#l00162">DeleteAttach()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00824">DeleteFolder()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00139">DeleteMessage()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00734">DeletePropertiesNoReplicate()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00544">DeleteProps()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00739">EmptyFolder()</a>, <a class="el" href="IMAPITable_8c_source.html#l01505">ExpandRow()</a>, <a class="el" href="IMAPITable_8c_source.html#l01215">FindRow()</a>, <a class="el" href="IMAPITable_8c_source.html#l00782">FreeBookmark()</a>, <a class="el" href="IMessage_8c_source.html#l00234">GetAttachmentTable()</a>, <a class="el" href="IMAPITable_8c_source.html#l01700">GetCollapseState()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00081">GetContentsTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00207">GetHierarchyTable()</a>, <a class="el" href="IUnknown_8c_source.html#l00276">GetIdFromLongTermId()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00922">GetIDsFromNames()</a>, <a class="el" href="FXICS_8c_source.html#l00051">GetLocalReplicaIds()</a>, <a class="el" href="IUnknown_8c_source.html#l00192">GetLongTermIdFromId()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00303">GetMessageStatus()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00818">GetNamesFromIDs()</a>, <a class="el" href="IMsgStore_8c_source.html#l00661">GetOwningServers()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00379">GetPropList()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00059">GetProps()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00464">GetPropsAll()</a>, <a class="el" href="IMsgStore_8c_source.html#l00396">GetReceiveFolder()</a>, <a class="el" href="IMsgStore_8c_source.html#l00483">GetReceiveFolderTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00395">GetRulesTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00704">GetSearchCriteria()</a>, <a class="el" href="IMAPITable_8c_source.html#l01337">GetStatus()</a>, <a class="el" href="IMsgStore_8c_source.html#l00768">GetStoreState()</a>, <a class="el" href="IStream_8c_source.html#l00408">GetStreamSize()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00303">GetTable()</a>, <a class="el" href="IMsgStore_8c_source.html#l00582">GetTransportFolder()</a>, <a class="el" href="freebusy_8c_source.html#l00057">GetUserFreeBusyData()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00223">HardDeleteMessage()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l01222">HardDeleteMessagesAndSubfolders()</a>, <a class="el" href="freebusy_8c_source.html#l00247">IsFreeBusyConflict()</a>, <a class="el" href="IStream_8c_source.html#l00748">LockRegionStream()</a>, <a class="el" href="IMSProvider_8c_source.html#l00233">Logoff()</a>, <a class="el" href="IMessage_8c_source.html#l00529">ModifyRecipients()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00493">ModifyTable()</a>, <a class="el" href="simple__mapi_8c_source.html#l00530">ModifyUserPermission()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00489">MoveCopyMessages()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00912">MoveFolder()</a>, <a class="el" href="IMessage_8c_source.html#l00324">OpenAttach()</a>, <a class="el" href="IMessage_8c_source.html#l01408">OpenEmbeddedMessage()</a>, <a class="el" href="IMsgStore_8c_source.html#l00048">OpenFolder()</a>, <a class="el" href="IStoreFolder_8c_source.html#l00061">OpenMessage()</a>, <a class="el" href="IMsgStore_8c_source.html#l00219">OpenPublicFolderByName()</a>, <a class="el" href="IStream_8c_source.html#l00063">OpenStream()</a>, <a class="el" href="IMsgStore_8c_source.html#l00133">PublicFolderIsGhosted()</a>, <a class="el" href="IMAPITable_8c_source.html#l00325">QueryColumns()</a>, <a class="el" href="IMAPIProp_8c_source.html#l01035">QueryNamedProperties()</a>, <a class="el" href="IMAPITable_8c_source.html#l00147">QueryPosition()</a>, <a class="el" href="IMAPITable_8c_source.html#l00233">QueryRows()</a>, <a class="el" href="IMessage_8c_source.html#l00753">ReadRecipients()</a>, <a class="el" href="IStream_8c_source.html#l00164">ReadStream()</a>, <a class="el" href="IUnknown_8c_source.html#l00112">Release()</a>, <a class="el" href="IMessage_8c_source.html#l00836">RemoveAllRecipients()</a>, <a class="el" href="simple__mapi_8c_source.html#l00643">RemoveUserPermission()</a>, <a class="el" href="IMAPITable_8c_source.html#l01026">Reset()</a>, <a class="el" href="IMAPITable_8c_source.html#l01111">Restrict()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00295">SaveChangesAttachment()</a>, <a class="el" href="IMessage_8c_source.html#l01084">SaveChangesMessage()</a>, <a class="el" href="IMAPITable_8c_source.html#l00414">SeekRow()</a>, <a class="el" href="IMAPITable_8c_source.html#l00609">SeekRowApprox()</a>, <a class="el" href="IMAPITable_8c_source.html#l00504">SeekRowBookmark()</a>, <a class="el" href="IStream_8c_source.html#l00489">SeekStream()</a>, <a class="el" href="IMAPITable_8c_source.html#l01791">SetCollapseState()</a>, <a class="el" href="IMAPITable_8c_source.html#l00051">SetColumns()</a>, <a class="el" href="IMessage_8c_source.html#l01276">SetMessageReadFlag()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00397">SetMessageStatus()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00627">SetPropertiesNoReplicate()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00181">SetProps()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l01136">SetReadFlags()</a>, <a class="el" href="IMsgStore_8c_source.html#l00310">SetReceiveFolder()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00605">SetSearchCriteria()</a>, <a class="el" href="IXPLogon_8c_source.html#l00125">SetSpooler()</a>, <a class="el" href="IStream_8c_source.html#l00570">SetStreamSize()</a>, <a class="el" href="IMAPITable_8c_source.html#l00880">SortTable()</a>, <a class="el" href="IXPLogon_8c_source.html#l00199">SpoolerLockMessage()</a>, <a class="el" href="IMessage_8c_source.html#l00913">SubmitMessage()</a>, <a class="el" href="IMAPISupport_8c_source.html#l00073">Subscribe()</a>, <a class="el" href="IMsgStore_8c_source.html#l00876">TransportNewMail()</a>, <a class="el" href="IMessage_8c_source.html#l01159">TransportSend()</a>, <a class="el" href="IStream_8c_source.html#l00827">UnlockRegionStream()</a>, <a class="el" href="IStream_8c_source.html#l00994">WriteAndCommitStream()</a>, and <a class="el" href="IStream_8c_source.html#l00260">WriteStream()</a>.</p>
</div>
</div><p>
<a class="anchor" name="f49c3130b8cb47f741ff652fc53c1364"></a><!-- doxytag: member="mapi_object.c::mapi_object_init" ref="f49c3130b8cb47f741ff652fc53c1364" args="(mapi_object_t *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS mapi_object_init </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize MAPI object<p>
This function is required to be called before any manipulation of this MAPI object.<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</em> </td><td>the object to initialize</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></ul>
</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="mapi__object_8c.html#de2b4701fae8a110c476b894834831b9">mapi_object_release</a> </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="fetchappointment_8c-example.html#a3">fetchappointment.c</a>, and <a class="el" href="fetchmail_8c-example.html#a3">fetchmail.c</a>.</dl>
<p>Referenced by <a class="el" href="IMAPIFolder_8c_source.html#l00597">CreateFolder()</a>, <a class="el" href="freebusy_8c_source.html#l00057">GetUserFreeBusyData()</a>, <a class="el" href="simple__mapi_8c_source.html#l00530">ModifyUserPermission()</a>, <a class="el" href="simple__mapi_8c_source.html#l00643">RemoveUserPermission()</a>, and <a class="el" href="IMAPISupport_8c_source.html#l00073">Subscribe()</a>.</p>
</div>
</div><p>
<a class="anchor" name="3a4550bbdf5094863d579c3e74aa170f"></a><!-- doxytag: member="mapi_object.c::mapi_object_is_invalid" ref="3a4550bbdf5094863d579c3e74aa170f" args="(mapi_object_t *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mapi_object_is_invalid </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the supplied object has a valid handle<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</em> </td><td>pointer on the MAPI object to test</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, otherwise 1 </dd></dl>
<p>References <a class="el" href="mapi__object_8c_source.html#l00037">INVALID_HANDLE_VALUE</a>, and <a class="el" href="mapi__object_8c_source.html#l00264">mapi_object_get_handle()</a>.</p>
</div>
</div><p>
<a class="anchor" name="de2b4701fae8a110c476b894834831b9"></a><!-- doxytag: member="mapi_object.c::mapi_object_release" ref="de2b4701fae8a110c476b894834831b9" args="(mapi_object_t *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ void mapi_object_release </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Release MAPI object<p>
This function is required to be called when this MAPI object is no longer required.<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</em> </td><td>pointer on the MAPI object to release</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd>mapi_object_initialize, <a class="el" href="IUnknown_8c.html#b3f224d83f10cbbcbeeeff3f4f73f230">Release</a> </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="fetchappointment_8c-example.html#a15">fetchappointment.c</a>, and <a class="el" href="fetchmail_8c-example.html#a15">fetchmail.c</a>.</dl>
<p>References <a class="el" href="mapi__object_8c_source.html#l00037">INVALID_HANDLE_VALUE</a>, and <a class="el" href="IUnknown_8c_source.html#l00112">Release()</a>.</p>
<p>Referenced by <a class="el" href="freebusy_8c_source.html#l00057">GetUserFreeBusyData()</a>, <a class="el" href="IMSProvider_8c_source.html#l00233">Logoff()</a>, <a class="el" href="simple__mapi_8c_source.html#l00530">ModifyUserPermission()</a>, and <a class="el" href="simple__mapi_8c_source.html#l00643">RemoveUserPermission()</a>.</p>
</div>
</div><p>
<a class="anchor" name="6cad283dc5a1228734e816adb30aa53c"></a><!-- doxytag: member="mapi_object.c::mapi_object_set_handle" ref="6cad283dc5a1228734e816adb30aa53c" args="(mapi_object_t *obj, mapi_handle_t handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mapi_object_set_handle </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mapi_handle_t </td>
<td class="paramname"> <em>handle</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Associate a handle to a MAPI object<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</em> </td><td>pointer on the MAPI object on which handle has to be set </td></tr>
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>the MAPI handle value </td></tr>
</table>
</dl>
<p>Referenced by <a class="el" href="IStream_8c_source.html#l00902">CloneStream()</a>, <a class="el" href="IMessage_8c_source.html#l00077">CreateAttach()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00597">CreateFolder()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00048">CreateMessage()</a>, <a class="el" href="IMessage_8c_source.html#l00234">GetAttachmentTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00081">GetContentsTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00207">GetHierarchyTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00395">GetRulesTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00303">GetTable()</a>, <a class="el" href="IMessage_8c_source.html#l00324">OpenAttach()</a>, <a class="el" href="IMessage_8c_source.html#l01408">OpenEmbeddedMessage()</a>, <a class="el" href="IMsgStore_8c_source.html#l00048">OpenFolder()</a>, <a class="el" href="IStoreFolder_8c_source.html#l00061">OpenMessage()</a>, <a class="el" href="IMAPISession_8c_source.html#l00142">OpenPublicFolder()</a>, <a class="el" href="IMsgStore_8c_source.html#l00219">OpenPublicFolderByName()</a>, <a class="el" href="IStream_8c_source.html#l00063">OpenStream()</a>, <a class="el" href="IMAPISession_8c_source.html#l00306">OpenUserMailbox()</a>, and <a class="el" href="IMAPISupport_8c_source.html#l00073">Subscribe()</a>.</p>
</div>
</div><p>
<a class="anchor" name="87947ae1569ed162473811bb257922cb"></a><!-- doxytag: member="mapi_object.c::mapi_object_set_id" ref="87947ae1569ed162473811bb257922cb" args="(mapi_object_t *obj, mapi_id_t id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mapi_object_set_id </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mapi_id_t </td>
<td class="paramname"> <em>id</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the id for a given MAPI object<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</em> </td><td>pointer on the MAPI object to set the session for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>Identifier to set to the object obj </td></tr>
</table>
</dl>
<p>Referenced by <a class="el" href="IMAPIFolder_8c_source.html#l00597">CreateFolder()</a>, <a class="el" href="IMsgStore_8c_source.html#l00048">OpenFolder()</a>, and <a class="el" href="IMessage_8c_source.html#l01084">SaveChangesMessage()</a>.</p>
</div>
</div><p>
<a class="anchor" name="845af67422945480121797b8a44ab14d"></a><!-- doxytag: member="mapi_object.c::mapi_object_set_logon_id" ref="845af67422945480121797b8a44ab14d" args="(mapi_object_t *obj, uint8_t logon_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ void mapi_object_set_logon_id </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"> <em>logon_id</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the logon id for a given MAPI object<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</em> </td><td>pointer to the object to set the logon id for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>logon_id</em> </td><td>the logon identifier to associate to the MAPI object </td></tr>
</table>
</dl>
<p>Referenced by <a class="el" href="IStream_8c_source.html#l00902">CloneStream()</a>, <a class="el" href="IMessage_8c_source.html#l00077">CreateAttach()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00597">CreateFolder()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00048">CreateMessage()</a>, <a class="el" href="IMessage_8c_source.html#l00234">GetAttachmentTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00081">GetContentsTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00207">GetHierarchyTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00395">GetRulesTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00303">GetTable()</a>, <a class="el" href="IMessage_8c_source.html#l00324">OpenAttach()</a>, <a class="el" href="IMessage_8c_source.html#l01408">OpenEmbeddedMessage()</a>, <a class="el" href="IMsgStore_8c_source.html#l00048">OpenFolder()</a>, <a class="el" href="IStoreFolder_8c_source.html#l00061">OpenMessage()</a>, <a class="el" href="IMAPISession_8c_source.html#l00142">OpenPublicFolder()</a>, <a class="el" href="IMsgStore_8c_source.html#l00219">OpenPublicFolderByName()</a>, <a class="el" href="IStream_8c_source.html#l00063">OpenStream()</a>, and <a class="el" href="IMAPISession_8c_source.html#l00306">OpenUserMailbox()</a>.</p>
</div>
</div><p>
<a class="anchor" name="5ae14832b40db995554d07a2bbdb59fd"></a><!-- doxytag: member="mapi_object.c::mapi_object_set_logon_store" ref="5ae14832b40db995554d07a2bbdb59fd" args="(mapi_object_t *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ void mapi_object_set_logon_store </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Mark a MAPI object as a store object<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</em> </td><td>pointer to the object to set the store boolean for </td></tr>
</table>
</dl>
<p>Referenced by <a class="el" href="IMAPISession_8c_source.html#l00142">OpenPublicFolder()</a>, and <a class="el" href="IMAPISession_8c_source.html#l00306">OpenUserMailbox()</a>.</p>
</div>
</div><p>
<a class="anchor" name="373e9bd46155ea22e816fa66944f22a6"></a><!-- doxytag: member="mapi_object.c::mapi_object_set_session" ref="373e9bd46155ea22e816fa66944f22a6" args="(mapi_object_t *obj, struct mapi_session *session)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ void mapi_object_set_session </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct mapi_session * </td>
<td class="paramname"> <em>session</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the session for a given MAPI object<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</em> </td><td>pointer on the object to set the session for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>session</em> </td><td>pointer on the MAPI session to associate to the MAPI object </td></tr>
</table>
</dl>
<p>Referenced by <a class="el" href="IStream_8c_source.html#l00902">CloneStream()</a>, <a class="el" href="IMessage_8c_source.html#l00077">CreateAttach()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00597">CreateFolder()</a>, <a class="el" href="IMAPIFolder_8c_source.html#l00048">CreateMessage()</a>, <a class="el" href="IMessage_8c_source.html#l00234">GetAttachmentTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00081">GetContentsTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00207">GetHierarchyTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00395">GetRulesTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00303">GetTable()</a>, <a class="el" href="IMessage_8c_source.html#l00324">OpenAttach()</a>, <a class="el" href="IMessage_8c_source.html#l01408">OpenEmbeddedMessage()</a>, <a class="el" href="IMsgStore_8c_source.html#l00048">OpenFolder()</a>, <a class="el" href="IStoreFolder_8c_source.html#l00061">OpenMessage()</a>, <a class="el" href="IMAPISession_8c_source.html#l00142">OpenPublicFolder()</a>, <a class="el" href="IMsgStore_8c_source.html#l00219">OpenPublicFolderByName()</a>, <a class="el" href="IStream_8c_source.html#l00063">OpenStream()</a>, <a class="el" href="IMAPISession_8c_source.html#l00306">OpenUserMailbox()</a>, and <a class="el" href="IMAPISupport_8c_source.html#l00073">Subscribe()</a>.</p>
</div>
</div><p>
<a class="anchor" name="678facb39f5979fec7ad08f2659d5181"></a><!-- doxytag: member="mapi_object.c::mapi_object_table_init" ref="678facb39f5979fec7ad08f2659d5181" args="(TALLOC_CTX *mem_ctx, mapi_object_t *obj_table)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mapi_object_table_init </td>
<td>(</td>
<td class="paramtype">TALLOC_CTX * </td>
<td class="paramname"> <em>mem_ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj_table</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize MAPI object private data to store a MAPI object table<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>mem_ctx</em> </td><td>pointer on the memory context </td></tr>
<tr><td valign="top"></td><td valign="top"><em>obj_table</em> </td><td>pointer on the MAPI object </td></tr>
</table>
</dl>
<p>Referenced by <a class="el" href="IMAPIContainer_8c_source.html#l00081">GetContentsTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00207">GetHierarchyTable()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00395">GetRulesTable()</a>, and <a class="el" href="IMAPIContainer_8c_source.html#l00303">GetTable()</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>
