Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > 1760bbde8794f5b323299b3a051b5bd6 > files > 186

openchange-devel-0.9-11.fc14.x86_64.rpm

<html>
  <head>
    <title>MAPIClientLibraries 0.9 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.7.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="annotated.html"><span>Data&nbsp;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="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<h1>libmapi/mapi_id_array.c File Reference</h1>  </div>
</div>
<div class="contents">

<p><a class="el" href="structmapi__id__array.html">mapi_id_array</a> support functions  
<a href="#_details">More...</a></p>
<code>#include &lt;<a class="el" href="libmapi_8h.html">libmapi/libmapi.h</a>&gt;</code><br/>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__id__array_8c.html#a1c892d6a5bbe136569f31da40462bc1b">mapi_id_array_add_id</a> (<a class="el" href="structmapi__id__array.html">mapi_id_array_t</a> *id, <a class="el" href="mapi__object_8h.html#ac1033858b28ee56b5f4d1578c297b87e">mapi_id_t</a> fid)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__id__array_8c.html#a8865ab595f24ef37fac4c91c2d7fca10">mapi_id_array_add_obj</a> (<a class="el" href="structmapi__id__array.html">mapi_id_array_t</a> *id, <a class="el" href="structmapi__object.html">mapi_object_t</a> *obj)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__id__array_8c.html#a5e03a889079867d34d4df410a5b25984">mapi_id_array_del_id</a> (<a class="el" href="structmapi__id__array.html">mapi_id_array_t</a> *id, <a class="el" href="mapi__object_8h.html#ac1033858b28ee56b5f4d1578c297b87e">mapi_id_t</a> fid)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__id__array_8c.html#a4310b8d706620f0bf6f7f2e3664c4d81">mapi_id_array_del_obj</a> (<a class="el" href="structmapi__id__array.html">mapi_id_array_t</a> *id, <a class="el" href="structmapi__object.html">mapi_object_t</a> *obj)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__id__array_8c.html#a5cc08c5509c61008c51d7214d2a4ee58">mapi_id_array_get</a> (TALLOC_CTX *mem_ctx, <a class="el" href="structmapi__id__array.html">mapi_id_array_t</a> *id, <a class="el" href="mapi__object_8h.html#ac1033858b28ee56b5f4d1578c297b87e">mapi_id_t</a> **ContainerList)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__id__array_8c.html#a5356627ab79e666c7eb6699366d81add">mapi_id_array_init</a> (<a class="el" href="structmapi__id__array.html">mapi_id_array_t</a> *id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mapi__id__array_8c.html#adf043bc751c527157f383ecb76af82d9">mapi_id_array_release</a> (<a class="el" href="structmapi__id__array.html">mapi_id_array_t</a> *id)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="structmapi__id__array.html">mapi_id_array</a> support functions </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a1c892d6a5bbe136569f31da40462bc1b"></a><!-- doxytag: member="mapi_id_array.c::mapi_id_array_add_id" ref="a1c892d6a5bbe136569f31da40462bc1b" 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"><a class="el" href="structmapi__id__array.html">mapi_id_array_t</a> *&nbsp;</td>
          <td class="paramname"> <em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="mapi__object_8h.html#ac1033858b28ee56b5f4d1578c297b87e">mapi_id_t</a>&nbsp;</td>
          <td class="paramname"> <em>fid</em></td><td>&nbsp;</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><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>pointer to a <a class="el" href="structmapi__id__array.html">mapi_id_array</a> structure </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>fid</em>&nbsp;</td><td>the container ID</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Developers may also call <a class="el" href="IUnknown_8c.html#a8237c7fc76377cb07f3f55920d6f20de">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"><dt><b>See also:</b></dt><dd><a class="el" href="proto_8h.html#a3dfe35b954981867acae68bba8793423">mapi_id_array_add_obj</a> </dd></dl>

<p>References <a class="el" href="dlinklist_8h.html#a416df1fd77df5d1568779b3c62dba178">DLIST_ADD</a>, <a class="el" href="cdo__mapi_8c.html#aa3c2b68912988f290961037c76478495">global_mapi_ctx</a>, <a class="el" href="structmapi__container__list.html#ab55051cba41fdb58385e255f80699a48">mapi_container_list::id</a>, <a class="el" href="structmapi__id__array.html#a54b0486471a0fc9021c47963cc989c3d">mapi_id_array::lpContainerList</a>, and <a class="el" href="mapicode_8h.html#a72f77c7e5d097e7b47c57c0405070d0c">OPENCHANGE_RETVAL_IF</a>.</p>

</div>
</div>
<a class="anchor" id="a8865ab595f24ef37fac4c91c2d7fca10"></a><!-- doxytag: member="mapi_id_array.c::mapi_id_array_add_obj" ref="a8865ab595f24ef37fac4c91c2d7fca10" 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"><a class="el" href="structmapi__id__array.html">mapi_id_array_t</a> *&nbsp;</td>
          <td class="paramname"> <em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structmapi__object.html">mapi_object_t</a> *&nbsp;</td>
          <td class="paramname"> <em>obj</em></td><td>&nbsp;</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><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>pointer to a <a class="el" href="structmapi__id__array.html">mapi_id_array</a> structure </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>obj</em>&nbsp;</td><td>pointer on the mapi object we retrieve the container ID from</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Developers may also call <a class="el" href="IUnknown_8c.html#a8237c7fc76377cb07f3f55920d6f20de">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"><dt><b>See also:</b></dt><dd><a class="el" href="proto_8h.html#a70461eb0bd7972c833e5aeeed170d56b">mapi_id_array_add_id</a> </dd></dl>

<p>References <a class="el" href="dlinklist_8h.html#a416df1fd77df5d1568779b3c62dba178">DLIST_ADD</a>, <a class="el" href="cdo__mapi_8c.html#aa3c2b68912988f290961037c76478495">global_mapi_ctx</a>, <a class="el" href="structmapi__container__list.html#ab55051cba41fdb58385e255f80699a48">mapi_container_list::id</a>, <a class="el" href="structmapi__id__array.html#a54b0486471a0fc9021c47963cc989c3d">mapi_id_array::lpContainerList</a>, <a class="el" href="mapi__object_8c.html#ad4477e1e7c6dd8314638a9886b570209">mapi_object_get_id()</a>, and <a class="el" href="mapicode_8h.html#a72f77c7e5d097e7b47c57c0405070d0c">OPENCHANGE_RETVAL_IF</a>.</p>

</div>
</div>
<a class="anchor" id="a5e03a889079867d34d4df410a5b25984"></a><!-- doxytag: member="mapi_id_array.c::mapi_id_array_del_id" ref="a5e03a889079867d34d4df410a5b25984" 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"><a class="el" href="structmapi__id__array.html">mapi_id_array_t</a> *&nbsp;</td>
          <td class="paramname"> <em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="mapi__object_8h.html#ac1033858b28ee56b5f4d1578c297b87e">mapi_id_t</a>&nbsp;</td>
          <td class="paramname"> <em>fid</em></td><td>&nbsp;</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><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>pointer to a <a class="el" href="structmapi__id__array.html">mapi_id_array</a> structure </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>fid</em>&nbsp;</td><td>the container ID</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Developers may also call <a class="el" href="IUnknown_8c.html#a8237c7fc76377cb07f3f55920d6f20de">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"><dt><b>See also:</b></dt><dd><a class="el" href="proto_8h.html#a70461eb0bd7972c833e5aeeed170d56b">mapi_id_array_add_id</a> </dd></dl>

<p>References <a class="el" href="structmapi__id__array.html#a2d3dad88056dae791e6e92c8d8ea0bc7">mapi_id_array::count</a>, <a class="el" href="dlinklist_8h.html#aa0a965f93e7b5bf2c7c95b380f5af2df">DLIST_REMOVE</a>, <a class="el" href="cdo__mapi_8c.html#aa3c2b68912988f290961037c76478495">global_mapi_ctx</a>, <a class="el" href="structmapi__container__list.html#ab55051cba41fdb58385e255f80699a48">mapi_container_list::id</a>, <a class="el" href="structmapi__id__array.html#a54b0486471a0fc9021c47963cc989c3d">mapi_id_array::lpContainerList</a>, <a class="el" href="structmapi__container__list.html#ad4cddd625d7429e8cbd814be51f7a509">mapi_container_list::next</a>, and <a class="el" href="mapicode_8h.html#a72f77c7e5d097e7b47c57c0405070d0c">OPENCHANGE_RETVAL_IF</a>.</p>

</div>
</div>
<a class="anchor" id="a4310b8d706620f0bf6f7f2e3664c4d81"></a><!-- doxytag: member="mapi_id_array.c::mapi_id_array_del_obj" ref="a4310b8d706620f0bf6f7f2e3664c4d81" 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"><a class="el" href="structmapi__id__array.html">mapi_id_array_t</a> *&nbsp;</td>
          <td class="paramname"> <em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structmapi__object.html">mapi_object_t</a> *&nbsp;</td>
          <td class="paramname"> <em>obj</em></td><td>&nbsp;</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><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>pointer to a <a class="el" href="structmapi__id__array.html">mapi_id_array</a> structure </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>obj</em>&nbsp;</td><td>pointer on the mapi object we retrieve the container ID from</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Developers may also call <a class="el" href="IUnknown_8c.html#a8237c7fc76377cb07f3f55920d6f20de">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"><dt><b>See also:</b></dt><dd><a class="el" href="proto_8h.html#a70461eb0bd7972c833e5aeeed170d56b">mapi_id_array_add_id</a> </dd></dl>

<p>References <a class="el" href="structmapi__id__array.html#a2d3dad88056dae791e6e92c8d8ea0bc7">mapi_id_array::count</a>, <a class="el" href="dlinklist_8h.html#aa0a965f93e7b5bf2c7c95b380f5af2df">DLIST_REMOVE</a>, <a class="el" href="cdo__mapi_8c.html#aa3c2b68912988f290961037c76478495">global_mapi_ctx</a>, <a class="el" href="structmapi__container__list.html#ab55051cba41fdb58385e255f80699a48">mapi_container_list::id</a>, <a class="el" href="structmapi__id__array.html#a54b0486471a0fc9021c47963cc989c3d">mapi_id_array::lpContainerList</a>, <a class="el" href="mapi__object_8c.html#ad4477e1e7c6dd8314638a9886b570209">mapi_object_get_id()</a>, <a class="el" href="structmapi__container__list.html#ad4cddd625d7429e8cbd814be51f7a509">mapi_container_list::next</a>, and <a class="el" href="mapicode_8h.html#a72f77c7e5d097e7b47c57c0405070d0c">OPENCHANGE_RETVAL_IF</a>.</p>

</div>
</div>
<a class="anchor" id="a5cc08c5509c61008c51d7214d2a4ee58"></a><!-- doxytag: member="mapi_id_array.c::mapi_id_array_get" ref="a5cc08c5509c61008c51d7214d2a4ee58" 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 *&nbsp;</td>
          <td class="paramname"> <em>mem_ctx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structmapi__id__array.html">mapi_id_array_t</a> *&nbsp;</td>
          <td class="paramname"> <em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="mapi__object_8h.html#ac1033858b28ee56b5f4d1578c297b87e">mapi_id_t</a> **&nbsp;</td>
          <td class="paramname"> <em>ContainerList</em></td><td>&nbsp;</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><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>&nbsp;</td><td>allocated talloc pointer </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>pointer to a <a class="el" href="structmapi__id__array.html">mapi_id_array</a> structure </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ContainerList</em>&nbsp;</td><td>pointer on a pointer of uint64_t values</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Developers may also call <a class="el" href="IUnknown_8c.html#a8237c7fc76377cb07f3f55920d6f20de">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"><dt><b>See also:</b></dt><dd><a class="el" href="proto_8h.html#ac9358749be2737f24bcd909df8a75f56">GetSearchCriteria</a> </dd></dl>

<p>References <a class="el" href="structmapi__id__array.html#a2d3dad88056dae791e6e92c8d8ea0bc7">mapi_id_array::count</a>, <a class="el" href="cdo__mapi_8c.html#aa3c2b68912988f290961037c76478495">global_mapi_ctx</a>, <a class="el" href="structmapi__container__list.html#ab55051cba41fdb58385e255f80699a48">mapi_container_list::id</a>, <a class="el" href="structmapi__id__array.html#a54b0486471a0fc9021c47963cc989c3d">mapi_id_array::lpContainerList</a>, <a class="el" href="structmapi__container__list.html#ad4cddd625d7429e8cbd814be51f7a509">mapi_container_list::next</a>, and <a class="el" href="mapicode_8h.html#a72f77c7e5d097e7b47c57c0405070d0c">OPENCHANGE_RETVAL_IF</a>.</p>

<p>Referenced by <a class="el" href="proto_8h.html#a583351a289546184e2560eac39f5a3d6">MoveCopyMessages()</a>, and <a class="el" href="proto_8h.html#a0ce94351576d968926636487793beaed">SetSearchCriteria()</a>.</p>

</div>
</div>
<a class="anchor" id="a5356627ab79e666c7eb6699366d81add"></a><!-- doxytag: member="mapi_id_array.c::mapi_id_array_init" ref="a5356627ab79e666c7eb6699366d81add" 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"><a class="el" href="structmapi__id__array.html">mapi_id_array_t</a> *&nbsp;</td>
          <td class="paramname"> <em>id</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Initialize a <a class="el" href="structmapi__id__array.html">mapi_id_array</a> structure</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>pointer to a <a class="el" href="structmapi__id__array.html">mapi_id_array</a> structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Developers may also call <a class="el" href="IUnknown_8c.html#a8237c7fc76377cb07f3f55920d6f20de">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"><dt><b>See also:</b></dt><dd><a class="el" href="proto_8h.html#a2203b8290779dbce1b8e14fc286b7636">mapi_id_array_release</a> </dd></dl>

<p>References <a class="el" href="cdo__mapi_8c.html#aa3c2b68912988f290961037c76478495">global_mapi_ctx</a>, <a class="el" href="structmapi__ctx.html#ada2a491501fdb736ced986fec5ffedc2">mapi_ctx::mem_ctx</a>, and <a class="el" href="mapicode_8h.html#a72f77c7e5d097e7b47c57c0405070d0c">OPENCHANGE_RETVAL_IF</a>.</p>

</div>
</div>
<a class="anchor" id="adf043bc751c527157f383ecb76af82d9"></a><!-- doxytag: member="mapi_id_array.c::mapi_id_array_release" ref="adf043bc751c527157f383ecb76af82d9" 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"><a class="el" href="structmapi__id__array.html">mapi_id_array_t</a> *&nbsp;</td>
          <td class="paramname"> <em>id</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Uninitialize a <a class="el" href="structmapi__id__array.html">mapi_id_array</a> structure</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>pointer to a <a class="el" href="structmapi__id__array.html">mapi_id_array</a> structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Developers may also call <a class="el" href="IUnknown_8c.html#a8237c7fc76377cb07f3f55920d6f20de">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"><dt><b>See also:</b></dt><dd><a class="el" href="proto_8h.html#a98e7322b5fd9c508aae8cf3c1eafc0fa">mapi_id_array_init</a> </dd></dl>

<p>References <a class="el" href="cdo__mapi_8c.html#aa3c2b68912988f290961037c76478495">global_mapi_ctx</a>, <a class="el" href="structmapi__id__array.html#a54b0486471a0fc9021c47963cc989c3d">mapi_id_array::lpContainerList</a>, and <a class="el" href="mapicode_8h.html#a72f77c7e5d097e7b47c57c0405070d0c">OPENCHANGE_RETVAL_IF</a>.</p>

</div>
</div>
</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>