<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_id_array.c File Reference</h1>mapi_id_array 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>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__id__array_8c.html#1c892d6a5bbe136569f31da40462bc1b">mapi_id_array_add_id</a> (mapi_id_array_t *id, mapi_id_t fid)</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__id__array_8c.html#8865ab595f24ef37fac4c91c2d7fca10">mapi_id_array_add_obj</a> (mapi_id_array_t *id, 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__id__array_8c.html#5e03a889079867d34d4df410a5b25984">mapi_id_array_del_id</a> (mapi_id_array_t *id, mapi_id_t fid)</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__id__array_8c.html#4310b8d706620f0bf6f7f2e3664c4d81">mapi_id_array_del_obj</a> (mapi_id_array_t *id, 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__id__array_8c.html#5cc08c5509c61008c51d7214d2a4ee58">mapi_id_array_get</a> (TALLOC_CTX *mem_ctx, mapi_id_array_t *id, mapi_id_t **ContainerList)</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__id__array_8c.html#5356627ab79e666c7eb6699366d81add">mapi_id_array_init</a> (mapi_id_array_t *id)</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__id__array_8c.html#df043bc751c527157f383ecb76af82d9">mapi_id_array_release</a> (mapi_id_array_t *id)</td></tr>
</table>
<hr><h2>Detailed Description</h2>
mapi_id_array support functions
<p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="1c892d6a5bbe136569f31da40462bc1b"></a><!-- doxytag: member="mapi_id_array.c::mapi_id_array_add_id" ref="1c892d6a5bbe136569f31da40462bc1b" args="(mapi_id_array_t *id, mapi_id_t fid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS mapi_id_array_add_id </td>
<td>(</td>
<td class="paramtype">mapi_id_array_t * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mapi_id_t </td>
<td class="paramname"> <em>fid</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a container ID to the list given its container ID<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>id</em> </td><td>pointer to a mapi_id_array structure </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fid</em> </td><td>the container ID</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: The mapi_id_array_t is uninitialized</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="mapi__id__array_8c.html#8865ab595f24ef37fac4c91c2d7fca10">mapi_id_array_add_obj</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="8865ab595f24ef37fac4c91c2d7fca10"></a><!-- doxytag: member="mapi_id_array.c::mapi_id_array_add_obj" ref="8865ab595f24ef37fac4c91c2d7fca10" args="(mapi_id_array_t *id, mapi_object_t *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS mapi_id_array_add_obj </td>
<td>(</td>
<td class="paramtype">mapi_id_array_t * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a container ID to the list given its mapi_object_t<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>id</em> </td><td>pointer to a mapi_id_array structure </td></tr>
<tr><td valign="top"></td><td valign="top"><em>obj</em> </td><td>pointer on the mapi object we retrieve the container ID from</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: The mapi_id_array_t is uninitialized</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="mapi__id__array_8c.html#1c892d6a5bbe136569f31da40462bc1b">mapi_id_array_add_id</a> </dd></dl>
<p>References <a class="el" href="mapi__object_8c_source.html#l00197">mapi_object_get_id()</a>.</p>
</div>
</div><p>
<a class="anchor" name="5e03a889079867d34d4df410a5b25984"></a><!-- doxytag: member="mapi_id_array.c::mapi_id_array_del_id" ref="5e03a889079867d34d4df410a5b25984" args="(mapi_id_array_t *id, mapi_id_t fid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS mapi_id_array_del_id </td>
<td>(</td>
<td class="paramtype">mapi_id_array_t * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mapi_id_t </td>
<td class="paramname"> <em>fid</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Delete a container ID from the list given its container ID<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>id</em> </td><td>pointer to a mapi_id_array structure </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fid</em> </td><td>the container ID</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: The mapi_id_array_t is uninitialized</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="mapi__id__array_8c.html#1c892d6a5bbe136569f31da40462bc1b">mapi_id_array_add_id</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="4310b8d706620f0bf6f7f2e3664c4d81"></a><!-- doxytag: member="mapi_id_array.c::mapi_id_array_del_obj" ref="4310b8d706620f0bf6f7f2e3664c4d81" args="(mapi_id_array_t *id, mapi_object_t *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS mapi_id_array_del_obj </td>
<td>(</td>
<td class="paramtype">mapi_id_array_t * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Delete a container ID from the list given its mapi_object_t<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>id</em> </td><td>pointer to a mapi_id_array structure </td></tr>
<tr><td valign="top"></td><td valign="top"><em>obj</em> </td><td>pointer on the mapi object we retrieve the container ID from</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: The mapi_id_array_t is uninitialized</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="mapi__id__array_8c.html#1c892d6a5bbe136569f31da40462bc1b">mapi_id_array_add_id</a> </dd></dl>
<p>References <a class="el" href="mapi__object_8c_source.html#l00197">mapi_object_get_id()</a>.</p>
</div>
</div><p>
<a class="anchor" name="5cc08c5509c61008c51d7214d2a4ee58"></a><!-- doxytag: member="mapi_id_array.c::mapi_id_array_get" ref="5cc08c5509c61008c51d7214d2a4ee58" args="(TALLOC_CTX *mem_ctx, mapi_id_array_t *id, mapi_id_t **ContainerList)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS mapi_id_array_get </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_id_array_t * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mapi_id_t ** </td>
<td class="paramname"> <em>ContainerList</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 ContainerList and store it within a uint64_t array.<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>allocated talloc pointer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>pointer to a mapi_id_array structure </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ContainerList</em> </td><td>pointer on a pointer of uint64_t values</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: The mapi_id_array_t is uninitialized</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="IMAPIContainer_8c.html#92fd04109c567b35cf94c8f8164347bb">GetSearchCriteria</a> </dd></dl>
<p>Referenced by <a class="el" href="IMAPIFolder_8c_source.html#l00489">MoveCopyMessages()</a>, and <a class="el" href="IMAPIContainer_8c_source.html#l00605">SetSearchCriteria()</a>.</p>
</div>
</div><p>
<a class="anchor" name="5356627ab79e666c7eb6699366d81add"></a><!-- doxytag: member="mapi_id_array.c::mapi_id_array_init" ref="5356627ab79e666c7eb6699366d81add" args="(mapi_id_array_t *id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS mapi_id_array_init </td>
<td>(</td>
<td class="paramtype">mapi_id_array_t * </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize a mapi_id_array structure<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>id</em> </td><td>pointer to a mapi_id_array structure</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: The mapi_id_array_t is uninitialized</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="mapi__id__array_8c.html#df043bc751c527157f383ecb76af82d9">mapi_id_array_release</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="df043bc751c527157f383ecb76af82d9"></a><!-- doxytag: member="mapi_id_array.c::mapi_id_array_release" ref="df043bc751c527157f383ecb76af82d9" args="(mapi_id_array_t *id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS mapi_id_array_release </td>
<td>(</td>
<td class="paramtype">mapi_id_array_t * </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Uninitialize a mapi_id_array structure<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>id</em> </td><td>pointer to a mapi_id_array structure</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: The mapi_id_array_t is uninitialized</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="mapi__id__array_8c.html#5356627ab79e666c7eb6699366d81add">mapi_id_array_init</a> </dd></dl>
</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>
