Sophie

Sophie

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

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> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<h1>libmapi/cdo_mapi.c File Reference</h1>  </div>
</div>
<div class="contents">

<p>MAPI subsystem related operations.  
<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="cdo__mapi_8c.html#a5ab8061fd4c2e86ff7675a746a2d6761">GetLoadparmContext</a> (struct loadparm_context **lp_ctx)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="cdo__mapi_8c.html#acd55ca55043b2a1c025c370725f1292a">MAPIInitialize</a> (const char *profiledb)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="cdo__mapi_8c.html#a2a42a622654ad8f1020d152028efe67b">MapiLogonEx</a> (struct <a class="el" href="structmapi__session.html">mapi_session</a> **session, const char *profname, const char *password)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="cdo__mapi_8c.html#a898df5110aab8e75e97574dc52acc1fa">MapiLogonProvider</a> (struct <a class="el" href="structmapi__session.html">mapi_session</a> **session, const char *profname, const char *password, enum <a class="el" href="mapi__provider_8h.html#ac4bbe7447bf5f60d55d9953a448c7e69">PROVIDER_ID</a> provider)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="cdo__mapi_8c.html#ab8230cc080e782e318a090786c3253de">MAPIUninitialize</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="cdo__mapi_8c.html#a4add2ba7cdd294f23289efb0dbecd2f9">SetMAPIDebugLevel</a> (uint32_t level)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="cdo__mapi_8c.html#a05f4dc52862a4148e82871139a17b8af">SetMAPIDumpData</a> (bool status)</td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structmapi__ctx.html">mapi_ctx</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="cdo__mapi_8c.html#aa3c2b68912988f290961037c76478495">global_mapi_ctx</a> = NULL</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>MAPI subsystem related operations. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a5ab8061fd4c2e86ff7675a746a2d6761"></a><!-- doxytag: member="cdo_mapi.c::GetLoadparmContext" ref="a5ab8061fd4c2e86ff7675a746a2d6761" args="(struct loadparm_context **lp_ctx)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">_PUBLIC_ enum MAPISTATUS GetLoadparmContext </td>
          <td>(</td>
          <td class="paramtype">struct loadparm_context **&nbsp;</td>
          <td class="paramname"> <em>lp_ctx</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Retrieve the global MAPI loadparm context</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>lp_ctx</em>&nbsp;</td><td>pointer to a pointer to the loadparm context that the function returns</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI_E_NOT_INITIALIZED or MAPI_E_INVALID_PARAMETER </dd></dl>

<p>References <a class="el" href="structmapi__ctx.html#a959500d050843deb2da3ed0537471b8f">mapi_ctx::lp_ctx</a>, and <a class="el" href="mapicode_8h.html#a72f77c7e5d097e7b47c57c0405070d0c">OPENCHANGE_RETVAL_IF</a>.</p>

</div>
</div>
<a class="anchor" id="acd55ca55043b2a1c025c370725f1292a"></a><!-- doxytag: member="cdo_mapi.c::MAPIInitialize" ref="acd55ca55043b2a1c025c370725f1292a" args="(const char *profiledb)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">_PUBLIC_ enum MAPISTATUS MAPIInitialize </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>profiledb</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Initialize mapi context global structure</p>
<p>This function inititalizes the MAPI subsystem and open the profile database pointed by profiledb .</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>profiledb</em>&nbsp;</td><td>profile database path</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_NOT_ENOUGH_RESOURCES: MAPI subsystem failed to allocate the necessary resources to operate properly</li>
<li>MAPI_E_NOT_FOUND: No suitable profile database was found in the path pointed by profiledb</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#ab8230cc080e782e318a090786c3253de">MAPIUninitialize</a> </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="fetchappointment_8c-example.html#a2">fetchappointment.c</a>, <a class="el" href="fetchmail_8c-example.html#a2">fetchmail.c</a>, and <a class="el" href="mapi__sample1_8c-example.html#a1">mapi_sample1.c</a>.</dd>
</dl>
<p>References <a class="el" href="structmapi__ctx.html#afe730d50ad23aa46b033fbddacfcdfef">mapi_ctx::dumpdata</a>, <a class="el" href="structmapi__ctx.html#a098e6f45325983c098872f72db315bb4">mapi_ctx::ldb_ctx</a>, <a class="el" href="structmapi__ctx.html#a959500d050843deb2da3ed0537471b8f">mapi_ctx::lp_ctx</a>, <a class="el" href="structmapi__ctx.html#ada2a491501fdb736ced986fec5ffedc2">mapi_ctx::mem_ctx</a>, <a class="el" href="mapicode_8h.html#a72f77c7e5d097e7b47c57c0405070d0c">OPENCHANGE_RETVAL_IF</a>, <a class="el" href="IProfAdmin_8c.html#a3947d9a43012d37deec3235148489f7a">OpenProfileStore()</a>, and <a class="el" href="structmapi__ctx.html#a50da7cefdb68d32a38e9a48997e440b5">mapi_ctx::session</a>.</p>

</div>
</div>
<a class="anchor" id="a2a42a622654ad8f1020d152028efe67b"></a><!-- doxytag: member="cdo_mapi.c::MapiLogonEx" ref="a2a42a622654ad8f1020d152028efe67b" args="(struct mapi_session **session, const char *profname, const char *password)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">_PUBLIC_ enum MAPISTATUS MapiLogonEx </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmapi__session.html">mapi_session</a> **&nbsp;</td>
          <td class="paramname"> <em>session</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>profname</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>password</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Create a full MAPI session</p>
<p>Open providers stored in the profile and return a pointer on a IMAPISession object.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>session</em>&nbsp;</td><td>pointer to a pointer to a MAPI session object </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>profname</em>&nbsp;</td><td>profile name to use </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>password</em>&nbsp;</td><td>password to use for the profile</td></tr>
  </table>
  </dd>
</dl>
<p>password should be set to NULL if the password has been stored in the profile.</p>
<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_NOT_ENOUGH_RESOURCES: MAPI subsystem failed to allocate the necessary resources to operate properly</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#ab293406ab51b9d0f5271a930480b2eec">MAPIInitialize</a>, <a class="el" href="proto_8h.html#a0b0c5711d2495b29a244814fecac3813">OpenProfile</a>, <a class="el" href="proto_8h.html#a0491efca1915d6709062bcd31b26cadf">MapiLogonProvider</a> </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="fetchappointment_8c-example.html#a5">fetchappointment.c</a>, <a class="el" href="fetchmail_8c-example.html#a5">fetchmail.c</a>, and <a class="el" href="mapi__sample1_8c-example.html#a5">mapi_sample1.c</a>.</dd>
</dl>
<p>References <a class="el" href="cdo__mapi_8c.html#a898df5110aab8e75e97574dc52acc1fa">MapiLogonProvider()</a>, <a class="el" href="mapi__provider_8h.html#ac4bbe7447bf5f60d55d9953a448c7e69a4dfcba777234e413cc14426e54dc6a72">PROVIDER_ID_EMSMDB</a>, and <a class="el" href="mapi__provider_8h.html#ac4bbe7447bf5f60d55d9953a448c7e69ac0899633ef5d7eaaa3d70c2994eb8ae6">PROVIDER_ID_NSPI</a>.</p>

</div>
</div>
<a class="anchor" id="a898df5110aab8e75e97574dc52acc1fa"></a><!-- doxytag: member="cdo_mapi.c::MapiLogonProvider" ref="a898df5110aab8e75e97574dc52acc1fa" args="(struct mapi_session **session, const char *profname, const char *password, enum PROVIDER_ID provider)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">_PUBLIC_ enum MAPISTATUS MapiLogonProvider </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmapi__session.html">mapi_session</a> **&nbsp;</td>
          <td class="paramname"> <em>session</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>profname</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>password</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="mapi__provider_8h.html#ac4bbe7447bf5f60d55d9953a448c7e69">PROVIDER_ID</a>&nbsp;</td>
          <td class="paramname"> <em>provider</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Initialize a session on the specified provider</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>session</em>&nbsp;</td><td>pointer to a pointer to a MAPI session object </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>profname</em>&nbsp;</td><td>profile name </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>password</em>&nbsp;</td><td>profile password </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>provider</em>&nbsp;</td><td>provider we want to establish a connection on</td></tr>
  </table>
  </dd>
</dl>
<p>password should be set to NULL if the password has been stored in the profile.</p>
<p>Supported providers are:</p>
<ul>
<li>PROVIDER_ID_NSPI: Address Book provider</li>
<li>PROVIDER_ID_EMSMDB: MAPI Store provider</li>
</ul>
<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_NOT_ENOUGH_RESOURCES: MAPI subsystem failed to allocate the necessary resources to operate properly</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#af2ff4c585dd8f2ab9b3ced2a3d2771c3">MapiLogonEx</a>, <a class="el" href="proto_8h.html#a0b0c5711d2495b29a244814fecac3813">OpenProfile</a>, <a class="el" href="proto_8h.html#ae14078fc5f0ec35ccd4282021f1fe679">LoadProfile</a> </dd></dl>

<p>References <a class="el" href="dlinklist_8h.html#a416df1fd77df5d1568779b3c62dba178">DLIST_ADD</a>, <a class="el" href="structmapi__session.html#a0d032340047573649b7527e660cac594">mapi_session::emsmdb</a>, <a class="el" href="emsmdb_8c.html#a4e73dc1cd7f2e88547ccfaed7fe1fa0f">emsmdb_disconnect_dtor()</a>, <a class="el" href="IProfAdmin_8c.html#af583325ef0be0c104f8a60b3065d5753">LoadProfile()</a>, <a class="el" href="IMSProvider_8c.html#ad5e7bff24db315bfc51c5cfc0bcb08c3">Logon()</a>, <a class="el" href="structmapi__session.html#a7a63adcc415b2220f2efb6cd175f2a67">mapi_session::logon_ids</a>, <a class="el" href="structmapi__ctx.html#ada2a491501fdb736ced986fec5ffedc2">mapi_ctx::mem_ctx</a>, <a class="el" href="structmapi__session.html#a71592db9a8e9e26c6057098468b50917">mapi_session::next</a>, <a class="el" href="structmapi__session.html#aebb5866afb67faf42642afd736740366">mapi_session::nspi</a>, <a class="el" href="nspi_8c.html#a24ae1ea81e7536bd2eebcddb3addea92">nspi_disconnect_dtor()</a>, <a class="el" href="mapicode_8h.html#a72f77c7e5d097e7b47c57c0405070d0c">OPENCHANGE_RETVAL_IF</a>, <a class="el" href="IProfAdmin_8c.html#a9f57e997c5abac3ba42a5335cf7221f0">OpenProfile()</a>, <a class="el" href="structmapi__session.html#aaf43b41f2628347b7944827c49334a5a">mapi_session::profile</a>, <a class="el" href="mapi__provider_8h.html#ac4bbe7447bf5f60d55d9953a448c7e69a4dfcba777234e413cc14426e54dc6a72">PROVIDER_ID_EMSMDB</a>, <a class="el" href="mapi__provider_8h.html#ac4bbe7447bf5f60d55d9953a448c7e69ac0899633ef5d7eaaa3d70c2994eb8ae6">PROVIDER_ID_NSPI</a>, and <a class="el" href="structmapi__ctx.html#a50da7cefdb68d32a38e9a48997e440b5">mapi_ctx::session</a>.</p>

<p>Referenced by <a class="el" href="proto_8h.html#af2ff4c585dd8f2ab9b3ced2a3d2771c3">MapiLogonEx()</a>.</p>

</div>
</div>
<a class="anchor" id="ab8230cc080e782e318a090786c3253de"></a><!-- doxytag: member="cdo_mapi.c::MAPIUninitialize" ref="ab8230cc080e782e318a090786c3253de" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">_PUBLIC_ void MAPIUninitialize </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Uninitialize MAPI subsystem</p>
<p>This function uninitializes the MAPI context and destroy recursively the whole mapi session and associated objects hierarchy</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="proto_8h.html#ab293406ab51b9d0f5271a930480b2eec">MAPIInitialize</a>, <a class="el" href="proto_8h.html#a8237c7fc76377cb07f3f55920d6f20de">GetLastError</a> </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="fetchappointment_8c-example.html#a25">fetchappointment.c</a>, <a class="el" href="fetchmail_8c-example.html#a25">fetchmail.c</a>, and <a class="el" href="mapi__sample1_8c-example.html#a6">mapi_sample1.c</a>.</dd>
</dl>
<p>References <a class="el" href="structmapi__notify__ctx.html#a1bdda4c03f900110d2c3f7704d64a303">mapi_notify_ctx::fd</a>, <a class="el" href="structmapi__ctx.html#ada2a491501fdb736ced986fec5ffedc2">mapi_ctx::mem_ctx</a>, <a class="el" href="structmapi__session.html#aac9c83fd213feed2c69ca8300551a44f">mapi_session::notify_ctx</a>, and <a class="el" href="structmapi__ctx.html#a50da7cefdb68d32a38e9a48997e440b5">mapi_ctx::session</a>.</p>

</div>
</div>
<a class="anchor" id="a4add2ba7cdd294f23289efb0dbecd2f9"></a><!-- doxytag: member="cdo_mapi.c::SetMAPIDebugLevel" ref="a4add2ba7cdd294f23289efb0dbecd2f9" args="(uint32_t level)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">_PUBLIC_ enum MAPISTATUS SetMAPIDebugLevel </td>
          <td>(</td>
          <td class="paramtype">uint32_t&nbsp;</td>
          <td class="paramname"> <em>level</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set MAPI debug level</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>level</em>&nbsp;</td><td>the debug level to set</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 function parameter is invalid </li>
</ul>
</dd></dl>

<p>References <a class="el" href="structmapi__ctx.html#a959500d050843deb2da3ed0537471b8f">mapi_ctx::lp_ctx</a>, and <a class="el" href="mapicode_8h.html#a72f77c7e5d097e7b47c57c0405070d0c">OPENCHANGE_RETVAL_IF</a>.</p>

</div>
</div>
<a class="anchor" id="a05f4dc52862a4148e82871139a17b8af"></a><!-- doxytag: member="cdo_mapi.c::SetMAPIDumpData" ref="a05f4dc52862a4148e82871139a17b8af" args="(bool status)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">_PUBLIC_ enum MAPISTATUS SetMAPIDumpData </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>status</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Enable MAPI network trace output</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>status</em>&nbsp;</td><td>the status</td></tr>
  </table>
  </dd>
</dl>
<p>possible status values/behavior:</p>
<ol type="1">
<li>true: Network traces are displayed on stdout</li>
<li>false: Network traces are not displayed on stdout</li>
</ol>
<dl class="return"><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI_E_NOT_INITIALIZED </dd></dl>

<p>References <a class="el" href="structmapi__ctx.html#afe730d50ad23aa46b033fbddacfcdfef">mapi_ctx::dumpdata</a>, and <a class="el" href="mapicode_8h.html#a72f77c7e5d097e7b47c57c0405070d0c">OPENCHANGE_RETVAL_IF</a>.</p>

</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="aa3c2b68912988f290961037c76478495"></a><!-- doxytag: member="cdo_mapi.c::global_mapi_ctx" ref="aa3c2b68912988f290961037c76478495" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structmapi__ctx.html">mapi_ctx</a>* <a class="el" href="libmapi_8h.html#a2f0254c0485070d548ac1a002b1069c9">global_mapi_ctx</a> = NULL</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Referenced by <a class="el" href="proto_8h.html#a66c99e4c6eb8a7eae42a0abac01fa75b">Abort()</a>, <a class="el" href="proto_8h.html#ac6cfa306b6e2571569cb814110bd2b08">AbortSubmit()</a>, <a class="el" href="proto_8h.html#ad08d305d256d71bcad693f3fca0110b2">AddressTypes()</a>, <a class="el" href="simple__mapi_8c.html#a2445fb102be62563bdd8d24025f3be2b">AddUserPermission()</a>, <a class="el" href="proto_8h.html#a1d43e4c1e6f232fccf8c6fb95f19ea34">cast_mapi_SPropValue()</a>, <a class="el" href="proto_8h.html#a51741a0845d53522445a466422ea94b1">cast_SPropValue()</a>, <a class="el" href="proto_8h.html#aff3ad6ae2f56ce102be53059e51731fd">CloneStream()</a>, <a class="el" href="proto_8h.html#a0152e531768ef61f4d8a41f600c7fea1">CollapseRow()</a>, <a class="el" href="proto_8h.html#a745704b6a7fc08573e87571023cbfc44">CommitStream()</a>, <a class="el" href="proto_8h.html#a4716ce81dca05da5c568db239f95acfe">CopyFolder()</a>, <a class="el" href="proto_8h.html#a8ec4ba29f2a9b89edda4cda1c4c4856c">CopyProps()</a>, <a class="el" href="proto_8h.html#acb5175bbc1caa88d0d5b8ed053b02b34">CopyTo()</a>, <a class="el" href="proto_8h.html#a6fb9d9166a531189cf0d123b007609b5">CopyToStream()</a>, <a class="el" href="proto_8h.html#a9f7152a9db034fbf7cc7fa8e481bd226">CreateAttach()</a>, <a class="el" href="proto_8h.html#ae26c5f046e906601b2dd367f738e1658">CreateBookmark()</a>, <a class="el" href="proto_8h.html#aa0d3c0451ce5f8584cce650ca3223b04">CreateFolder()</a>, <a class="el" href="proto_8h.html#acd2d9aaa13e6138886bacdcea51695d3">CreateMessage()</a>, <a class="el" href="proto_8h.html#a494b4286cefe9e170c3f94c905c321fa">CreateProfile()</a>, <a class="el" href="proto_8h.html#a82fa868e57de4841b97cc4b4e9f6fb8d">DeleteAttach()</a>, <a class="el" href="proto_8h.html#a89202179905d03cb95b31b430790b9a1">DeleteFolder()</a>, <a class="el" href="proto_8h.html#abd450cbfa8897602cbc1cc7e0fa56ce5">DeleteMessage()</a>, <a class="el" href="proto_8h.html#a833c3aae4ee37b3f7d6363adbe1d92c5">DeleteProfile()</a>, <a class="el" href="proto_8h.html#a65bbd0ee31de96fd372da08b3e2347e8">DeletePropertiesNoReplicate()</a>, <a class="el" href="proto_8h.html#a829a7a28788124c422e42d007b47e9e3">DeleteProps()</a>, <a class="el" href="proto_8h.html#a5f9f3f93fc555e96f05ac0a9fd0a3e9d">DispatchNotifications()</a>, <a class="el" href="proto_8h.html#a364dcbce3198d58aa0ab6a813411bcbf">EmptyFolder()</a>, <a class="el" href="emsmdb_8c.html#a3ceb606e3d9b8d34e0f243b19d6a8373">emsmdb_bind_notification()</a>, <a class="el" href="proto_8h.html#a0f1f99358ce5c603e26d5efe9ebc3c43">emsmdb_get_info()</a>, <a class="el" href="emsmdb_8c.html#a500b279eff945d3ee9ef15d2f5d53cf2">emsmdb_register_notification()</a>, <a class="el" href="proto_8h.html#ac449d69d77ab398535923a0859691ddf">ExpandRow()</a>, <a class="el" href="proto_8h.html#afb0a9a443514add2c3daa664a6a5448d">FindProfileAttr()</a>, <a class="el" href="proto_8h.html#ae3c55e0b3aaaa9fd6056018d202f785d">FindRow()</a>, <a class="el" href="proto_8h.html#aa90bfd47eded92fdd5e73cb1a0023fd3">FreeBookmark()</a>, <a class="el" href="proto_8h.html#adfba66f98839bc597c0a09803a30ff24">GetABRecipientInfo()</a>, <a class="el" href="proto_8h.html#a3323b8ace0a76a8f9e53aa989bc886c1">GetAttachmentTable()</a>, <a class="el" href="simple__mapi_8c.html#ac77ec981ccaa328f0fd1c9cdc03ae153">GetBestBody()</a>, <a class="el" href="proto_8h.html#a80bfa91f91a0627cb58fa6ce757d72c4">GetCollapseState()</a>, <a class="el" href="proto_8h.html#a8005a7edf302693a7277f1351382d0d5">GetContentsTable()</a>, <a class="el" href="simple__mapi_8c.html#afd821395dac16d9491e8cecd9743ff95">GetDefaultFolder()</a>, <a class="el" href="proto_8h.html#a8f5951b6d64365bcbd081cee2c814990">GetDefaultProfile()</a>, <a class="el" href="simple__mapi_8c.html#a7bc03d63237c2f807fe8f272a1e5c0f2">GetDefaultPublicFolder()</a>, <a class="el" href="simple__mapi_8c.html#a7b3fc634875a5d59ea50a4b8f0b11074">GetFolderItemsCount()</a>, <a class="el" href="proto_8h.html#a9e77f769cd8552117fcb3b6bff4e03dd">GetGALTable()</a>, <a class="el" href="proto_8h.html#ad5362cafba2a76a70b112c966abe5907">GetHierarchyTable()</a>, <a class="el" href="proto_8h.html#a938413416b0e656c72192174fc3b0eae">GetIdFromLongTermId()</a>, <a class="el" href="proto_8h.html#af2084aa1318156973399cd8c7971912e">GetIDsFromNames()</a>, <a class="el" href="proto_8h.html#a25e3ad84c849f51eed573febe892b9a6">GetLocalReplicaIds()</a>, <a class="el" href="proto_8h.html#a4cad41f7bd69a78a74285df9db265e73">GetLongTermIdFromId()</a>, <a class="el" href="proto_8h.html#a535ea169793b6eb4cd76a669672761d1">GetMessageStatus()</a>, <a class="el" href="proto_8h.html#ae3c6c832f8dddb0a4755dbc6c19c5233">GetNamesFromIDs()</a>, <a class="el" href="proto_8h.html#acb6b46bd65de461b26a247092590814b">GetOutboxFolder()</a>, <a class="el" href="proto_8h.html#ae7c80d484ca025749951a291c61be3e2">GetOwningServers()</a>, <a class="el" href="proto_8h.html#a38910e8760dbc1c65edb66f45d3f4cbd">GetProfileAttr()</a>, <a class="el" href="proto_8h.html#a09e5b0aa9f4c72b2cc85cc8f58a58806">GetProfileTable()</a>, <a class="el" href="proto_8h.html#aed96168262c4acfeab8d06ff35601aeb">GetPropList()</a>, <a class="el" href="proto_8h.html#a2302fd8484a99435dcf605f79cf9e8ba">GetProps()</a>, <a class="el" href="proto_8h.html#ae158380be31ef5121ebcccb99c5f980d">GetPropsAll()</a>, <a class="el" href="proto_8h.html#a1feaac1c7b54b25e599d8dbf68a72faf">GetReceiveFolder()</a>, <a class="el" href="proto_8h.html#ab60a3c481121ff3bce77f9266112a783">GetReceiveFolderTable()</a>, <a class="el" href="proto_8h.html#a7f0a6f074da61394f2cdeba437d8fc12">GetRulesTable()</a>, <a class="el" href="proto_8h.html#ac9358749be2737f24bcd909df8a75f56">GetSearchCriteria()</a>, <a class="el" href="proto_8h.html#a198f286f90fe17887d8af784292348d2">GetStatus()</a>, <a class="el" href="proto_8h.html#a15fb593a6c5c39272a48f478c3738d81">GetStoreState()</a>, <a class="el" href="proto_8h.html#a35a0dde04de76bbe473a19e92ec5f723">GetStreamSize()</a>, <a class="el" href="proto_8h.html#a0c8a9b8fc54139a1411aa9264acbe200">GetTable()</a>, <a class="el" href="proto_8h.html#ac896118a7a75e0d214a81cfea01089d9">GetTransportFolder()</a>, <a class="el" href="proto_8h.html#a51ddeca55f13055917a8b43d28a5f11f">GetUserFreeBusyData()</a>, <a class="el" href="proto_8h.html#ad1b0270ffa8b70cdca16c0ece8661c96">GetValidAttach()</a>, <a class="el" href="proto_8h.html#a8af3857bd9d1eea00c7e5930599d2433">HardDeleteMessage()</a>, <a class="el" href="proto_8h.html#a89562462ecaf7522be6f0ed9d88125c5">HardDeleteMessagesAndSubfolders()</a>, <a class="el" href="proto_8h.html#ab76911cad62468f2d40c277e63e4b548">IsFreeBusyConflict()</a>, <a class="el" href="proto_8h.html#ae14078fc5f0ec35ccd4282021f1fe679">LoadProfile()</a>, <a class="el" href="proto_8h.html#af33e1c1b61a7b361621d68779342e811">LockRegionStream()</a>, <a class="el" href="proto_8h.html#a6a291e98161f80abee74f43f13c26b72">Logoff()</a>, <a class="el" href="IMSProvider_8c.html#ad5e7bff24db315bfc51c5cfc0bcb08c3">Logon()</a>, <a class="el" href="proto_8h.html#a70461eb0bd7972c833e5aeeed170d56b">mapi_id_array_add_id()</a>, <a class="el" href="proto_8h.html#a3dfe35b954981867acae68bba8793423">mapi_id_array_add_obj()</a>, <a class="el" href="proto_8h.html#a99ff1e3fa96eea20c58ddb664cea4be6">mapi_id_array_del_id()</a>, <a class="el" href="proto_8h.html#ae8bb320a745b1ad4e4f01a8436a6c009">mapi_id_array_del_obj()</a>, <a class="el" href="proto_8h.html#ad2744293f03c1c4882c9f304848bb257">mapi_id_array_get()</a>, <a class="el" href="proto_8h.html#a98e7322b5fd9c508aae8cf3c1eafc0fa">mapi_id_array_init()</a>, <a class="el" href="proto_8h.html#a2203b8290779dbce1b8e14fc286b7636">mapi_id_array_release()</a>, <a class="el" href="proto_8h.html#a2d0ae19a519f1845142373cbd61e677c">mapi_object_bookmark_debug()</a>, <a class="el" href="mapi__object_8c.html#aede7db5a93dc819adc88cb4392a3314b">mapi_object_bookmark_find()</a>, <a class="el" href="proto_8h.html#af9ad52e7432492576a4402f0091ee7dd">mapi_object_bookmark_get_count()</a>, <a class="el" href="proto_8h.html#a08ac4ee13313f57770b683a96c55089e">mapi_object_init()</a>, <a class="el" href="proto_8h.html#a2ab74ccfb3fc60937e2d67185e33f018">mapi_profile_add_string_attr()</a>, <a class="el" href="proto_8h.html#aa1043111e9e45211d90f540d0d8f2d4f">mapi_profile_delete_string_attr()</a>, <a class="el" href="proto_8h.html#ab073d3eeac4d3aa6705bda7abecbc52a">mapi_profile_modify_string_attr()</a>, <a class="el" href="proto_8h.html#a23a01bb57f5080411a729f615e558b29">MAPIAllocateBuffer()</a>, <a class="el" href="proto_8h.html#a1166925df3bf36ba5bd3835d0917d1df">ModifyRecipients()</a>, <a class="el" href="proto_8h.html#afcd8006481ea667864a055148777a07e">ModifyTable()</a>, <a class="el" href="simple__mapi_8c.html#a9cb54788ad5b18ab5e714405a043b049">ModifyUserPermission()</a>, <a class="el" href="proto_8h.html#a875788729bf87923b16b1d2cab952d59">MonitorNotification()</a>, <a class="el" href="proto_8h.html#a583351a289546184e2560eac39f5a3d6">MoveCopyMessages()</a>, <a class="el" href="proto_8h.html#acf3f40942949ac192faaec2be8503992">MoveFolder()</a>, <a class="el" href="proto_8h.html#a8af2fe9cc98605fbda054d3091499ed2">OpenAttach()</a>, <a class="el" href="proto_8h.html#aaf3088b3837b1908e6bb6b14f906a4e0">OpenEmbeddedMessage()</a>, <a class="el" href="proto_8h.html#a5d20a82a73d463254ac5e688f0f0cb0f">OpenFolder()</a>, <a class="el" href="proto_8h.html#a26b91ebe67489ca9e12a2ad1ba71548c">OpenMessage()</a>, <a class="el" href="proto_8h.html#af3ccf6c1f83aa3659f7c04a4fcd1cf5f">OpenMsgStore()</a>, <a class="el" href="proto_8h.html#a0b0c5711d2495b29a244814fecac3813">OpenProfile()</a>, <a class="el" href="proto_8h.html#ac27ee071a1b0d8344bb0320a4a647f54">OpenPublicFolder()</a>, <a class="el" href="proto_8h.html#a8fda02d0b93fae98d923a82d86ca8c6c">OpenPublicFolderByName()</a>, <a class="el" href="proto_8h.html#a2be8f10c82ffcf8070e105f1a0d8c998">OpenStream()</a>, <a class="el" href="proto_8h.html#a7a2978c322cbed08f16de37682cdebde">OpenUserMailbox()</a>, <a class="el" href="proto_8h.html#a3309fcb17b899dc8f86ecd7d3ed59eb5">PublicFolderIsGhosted()</a>, <a class="el" href="proto_8h.html#ae03f50328f9ef6369d5169893c8488df">QueryColumns()</a>, <a class="el" href="proto_8h.html#aa223b65b8bbcd97353c64aecdf10bd85">QueryNamedProperties()</a>, <a class="el" href="proto_8h.html#a65befabbd077db9273226a6d59615fdd">QueryPosition()</a>, <a class="el" href="proto_8h.html#a3124e8442e355ace743f5e554698eaa1">QueryRows()</a>, <a class="el" href="proto_8h.html#a6bc72b5c38aa15725d1454ad2c3635d0">ReadRecipients()</a>, <a class="el" href="proto_8h.html#ae0ef7c1c994a63e9cec5b1379122ed86">ReadStream()</a>, <a class="el" href="proto_8h.html#a1eda5ec73d03a2a9afd0d3a68cc6615c">RegisterNotification()</a>, <a class="el" href="proto_8h.html#a96a886615abe0904621a25f73cb73839">Release()</a>, <a class="el" href="proto_8h.html#ab6424e4371c22d4cb24af0c5b954c46b">ReloadCachedInformation()</a>, <a class="el" href="proto_8h.html#ae625b8aeb2972e53df4608791fc77861">RemoveAllRecipients()</a>, <a class="el" href="simple__mapi_8c.html#a6b974921b0a3421b48933e564230d664">RemoveUserPermission()</a>, <a class="el" href="proto_8h.html#a228ea4355df5512a92fade1b13a0dbfa">RenameProfile()</a>, <a class="el" href="proto_8h.html#a57497a9ec70a70382ed908bc883aaa41">Reset()</a>, <a class="el" href="proto_8h.html#a30175af61e448af11db8ed103bea888c">ResolveNames()</a>, <a class="el" href="proto_8h.html#a5e1d04f08b99a53ba88a2de930f65a16">Restrict()</a>, <a class="el" href="proto_8h.html#abd1fe9cb35723ce717bc727f0d36ecee">RfrGetFQDNFromLegacyDN()</a>, <a class="el" href="proto_8h.html#a4b0204ca9b8ea9514474fa78b051075c">RfrGetNewDSA()</a>, <a class="el" href="proto_8h.html#a4f63e29f1a02772254ba88ff7d916dee">SaveChangesAttachment()</a>, <a class="el" href="proto_8h.html#aae796bfcac7ea8bb4be2d6ef7eb93a76">SaveChangesMessage()</a>, <a class="el" href="proto_8h.html#ad0f277a2179be5b0377797f695157961">SeekRow()</a>, <a class="el" href="proto_8h.html#a450c999da38c526f1e7b7d26ec3c53fb">SeekRowApprox()</a>, <a class="el" href="proto_8h.html#abe8573f64f67df4a07e454a85a246d2a">SeekRowBookmark()</a>, <a class="el" href="proto_8h.html#a96670d887617ee8e4d5982b8ccc31bdf">SeekStream()</a>, <a class="el" href="proto_8h.html#a44dd9d7916dbbacec81d716978fbb040">SetCollapseState()</a>, <a class="el" href="proto_8h.html#a8695fc542a0924df6f34f1ececda5e58">SetColumns()</a>, <a class="el" href="proto_8h.html#a248d788a78d8336e96991567ccb56df5">SetDefaultProfile()</a>, <a class="el" href="proto_8h.html#af372f4a887ab6f689b63d43d09b04344">SetMessageReadFlag()</a>, <a class="el" href="proto_8h.html#a1e1e4a1093f379c20f444043650727f2">SetMessageStatus()</a>, <a class="el" href="proto_8h.html#a0718735fdc7da84886484ba44305d4af">SetPropertiesNoReplicate()</a>, <a class="el" href="proto_8h.html#a0ddd5dd9827db2d23d94440042abab37">SetProps()</a>, <a class="el" href="proto_8h.html#a8bb55368bb250bd04840c17b90be39a1">SetReadFlags()</a>, <a class="el" href="proto_8h.html#a35ac4767be928b741f30b55ef2c82651">SetReceiveFolder()</a>, <a class="el" href="proto_8h.html#a0ce94351576d968926636487793beaed">SetSearchCriteria()</a>, <a class="el" href="proto_8h.html#ad055d10119b399237b824d6fef5849d7">SetSpooler()</a>, <a class="el" href="proto_8h.html#a457cd46e47a75728f62d2066cfe83415">SetStreamSize()</a>, <a class="el" href="proto_8h.html#a348540581920b0e663f1a008f25bb643">SortTable()</a>, <a class="el" href="IXPLogon_8c.html#a8f5946010110ea49ade2d27446f37941">SpoolerLockMessage()</a>, <a class="el" href="proto_8h.html#a26d57152d73d8087c87e705f65691e32">SubmitMessage()</a>, <a class="el" href="proto_8h.html#a73891d48327dd1afee64dba5b7cfddc0">Subscribe()</a>, <a class="el" href="proto_8h.html#a8fa0a6ef77dcb6a1671e228e6f8f1fa4">TransportNewMail()</a>, <a class="el" href="proto_8h.html#a0f5eb34ea6ecea5bdc54d7b74a323f08">TransportSend()</a>, <a class="el" href="proto_8h.html#a01b7bea488771aa983179a42abd5e928">UnlockRegionStream()</a>, <a class="el" href="proto_8h.html#ade9573642b24da1b4fbdbde2092f6048">Unsubscribe()</a>, <a class="el" href="proto_8h.html#a4b8479efbbc1fff738126b9fa6a2f791">WrapCompressedRTFStream()</a>, <a class="el" href="proto_8h.html#a0c3f3ba864f626e7a8fcd224cb2426fb">WriteAndCommitStream()</a>, and <a class="el" href="proto_8h.html#a2a14dfe1dcdacce01a7c7f67578632a0">WriteStream()</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>