<html>
<head>
<title>OpenChange Property Files 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 Page</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 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="#define-members">Defines</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>libocpf/proto.h File Reference</h1> </div>
</div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a568e6bde99652b7fd271ad206cfe38f5">__BEGIN_DECLS</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a115472f6d0d1035f1885658ce0821537">__END_DECLS</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a73b99266fc71410043dcddeb7b0ba447">_PRINTF_ATTRIBUTE</a>(a1, a2)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a73b99266fc71410043dcddeb7b0ba447">_PRINTF_ATTRIBUTE</a>(a1, a2) PRINTF_ATTRIBUTE(a1, a2)</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ void </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a2d0eedf8b9dadadf700dc9aa0342ce63">ocpf_dump</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#ae499f8dbacd1f1c0683c5024a41e014c">ocpf_dump_folder</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ void </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a36e896af93fe3039ab257ecb486f1fb8">ocpf_dump_named_property</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a278aa1f54ac465ce8ab501412ef45170">ocpf_dump_oleguid</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ void </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a3a8d8e8f032b00b4924047ba8e7f1805">ocpf_dump_property</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a65b1e863d68aa8fffb477e5c6c64f6cc">ocpf_dump_recipients</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#af98fd7149ec407cff0faff613434f0de">ocpf_dump_type</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#abb50cb36ec43492a6149f81cf4c0d10b">ocpf_dump_variable</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct SPropValue * </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a1e6a64ad3406eeb8dfed6d4e2b953fb2">ocpf_get_SPropValue</a> (uint32_t *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">__BEGIN_DECLS int </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a5cef35bf5965c71d9b3b7b34031c6690">ocpf_init</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a56f8e60fea6226cebee5e902524c6bd2">ocpf_OpenFolder</a> (mapi_object_t *, mapi_object_t *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a932df66fbd1bec388b871dd4350f7285">ocpf_parse</a> (const char *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a67c64196da27ef182d879db7f7eca25c">ocpf_release</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#aa45dd89024f37bbd36af6fed7f00a5c3">ocpf_set_Recipients</a> (TALLOC_CTX *, mapi_object_t *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a8251ef359d0fa2736e7587a32cffabba">ocpf_set_SPropValue</a> (TALLOC_CTX *, mapi_object_t *obj_folder, mapi_object_t *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ int </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a92380028e4063628979a2b964949deeb">ocpf_write_auto</a> (mapi_object_t *, struct mapi_SPropValue_array *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ int </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a2cef081b58d0fb7cc37beb2ac701476f">ocpf_write_commit</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ int </td><td class="memItemRight" valign="bottom"><a class="el" href="proto_8h.html#a29356f0b1be1837c516bd19deea13376">ocpf_write_init</a> (const char *, mapi_id_t)</td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="a568e6bde99652b7fd271ad206cfe38f5"></a><!-- doxytag: member="proto.h::__BEGIN_DECLS" ref="a568e6bde99652b7fd271ad206cfe38f5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define __BEGIN_DECLS</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a115472f6d0d1035f1885658ce0821537"></a><!-- doxytag: member="proto.h::__END_DECLS" ref="a115472f6d0d1035f1885658ce0821537" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define __END_DECLS</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a73b99266fc71410043dcddeb7b0ba447"></a><!-- doxytag: member="proto.h::_PRINTF_ATTRIBUTE" ref="a73b99266fc71410043dcddeb7b0ba447" args="(a1, a2)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define _PRINTF_ATTRIBUTE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">a1, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">a2</td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a73b99266fc71410043dcddeb7b0ba447"></a><!-- doxytag: member="proto.h::_PRINTF_ATTRIBUTE" ref="a73b99266fc71410043dcddeb7b0ba447" args="(a1, a2)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define _PRINTF_ATTRIBUTE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">a1, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">a2</td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> PRINTF_ATTRIBUTE(a1, a2)</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a2d0eedf8b9dadadf700dc9aa0342ce63"></a><!-- doxytag: member="proto.h::ocpf_dump" ref="a2d0eedf8b9dadadf700dc9aa0342ce63" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ void ocpf_dump </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="ocpf__dump_8h.html#a913a30aaae68bab9c263fd5208679335">indent</a>, <a class="el" href="ocpf__dump_8c.html#a644a2e9ba3b7b0d2949346413cf7c22c">ocpf_dump_folder()</a>, <a class="el" href="ocpf__dump_8c.html#a36e896af93fe3039ab257ecb486f1fb8">ocpf_dump_named_property()</a>, <a class="el" href="ocpf__dump_8c.html#a821fa936669e21069a86d55fd28b1a68">ocpf_dump_oleguid()</a>, <a class="el" href="ocpf__dump_8c.html#a3a8d8e8f032b00b4924047ba8e7f1805">ocpf_dump_property()</a>, <a class="el" href="ocpf__dump_8c.html#ae61c506124feb55b56142cba39827494">ocpf_dump_recipients()</a>, <a class="el" href="ocpf__dump_8c.html#a83cac1c655e32ac0fc77300ccf3b604b">ocpf_dump_type()</a>, and <a class="el" href="ocpf__dump_8c.html#ac42bf5b3b272f70e81096635586b48cd">ocpf_dump_variable()</a>.</p>
</div>
</div>
<a class="anchor" id="ae499f8dbacd1f1c0683c5024a41e014c"></a><!-- doxytag: member="proto.h::ocpf_dump_folder" ref="ae499f8dbacd1f1c0683c5024a41e014c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ocpf_dump_folder </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Dump OCPF Destination Folder</p>
<p>Dump OCPF Registered Destination Folder </p>
<p>References <a class="el" href="ocpf__dump_8h.html#a0fc095e9c8433e7f3538d3302958ef09">INDENT</a>, <a class="el" href="ocpf__dump_8h.html#a913a30aaae68bab9c263fd5208679335">indent</a>, <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a>, <a class="el" href="ocpf__dump_8h.html#a8aa5991eea4e36fdb3f8b9c9ccff5a05">OCPF_DUMP</a>, <a class="el" href="ocpf__dump_8h.html#aeb451b618b6e36b03799015b457094a6">OCPF_DUMP_TITLE</a>, and <a class="el" href="ocpf__dump_8h.html#a4723e75a8925192913e8035f152031f8">OCPF_DUMP_TOPLEVEL</a>.</p>
<p>Referenced by <a class="el" href="proto_8h.html#a2d0eedf8b9dadadf700dc9aa0342ce63">ocpf_dump()</a>.</p>
</div>
</div>
<a class="anchor" id="a36e896af93fe3039ab257ecb486f1fb8"></a><!-- doxytag: member="proto.h::ocpf_dump_named_property" ref="a36e896af93fe3039ab257ecb486f1fb8" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ void ocpf_dump_named_property </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="ocpf__dump_8h.html#a0fc095e9c8433e7f3538d3302958ef09">INDENT</a>, <a class="el" href="ocpf__dump_8h.html#a913a30aaae68bab9c263fd5208679335">indent</a>, <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a>, <a class="el" href="ocpf__dump_8h.html#ab93e0c884c42543d877d79d0d16cd3c9">OCPF_DUMP_SUBLEVEL</a>, <a class="el" href="ocpf__dump_8h.html#aeb451b618b6e36b03799015b457094a6">OCPF_DUMP_TITLE</a>, and <a class="el" href="ocpf__dump_8h.html#a4723e75a8925192913e8035f152031f8">OCPF_DUMP_TOPLEVEL</a>.</p>
<p>Referenced by <a class="el" href="proto_8h.html#a2d0eedf8b9dadadf700dc9aa0342ce63">ocpf_dump()</a>.</p>
</div>
</div>
<a class="anchor" id="a278aa1f54ac465ce8ab501412ef45170"></a><!-- doxytag: member="proto.h::ocpf_dump_oleguid" ref="a278aa1f54ac465ce8ab501412ef45170" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ocpf_dump_oleguid </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Dump OCPF OLEGUID</p>
<p>Dump OCPF Registered OLEGUID </p>
<p>References <a class="el" href="ocpf__dump_8h.html#a0fc095e9c8433e7f3538d3302958ef09">INDENT</a>, <a class="el" href="ocpf__dump_8h.html#a913a30aaae68bab9c263fd5208679335">indent</a>, <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a>, <a class="el" href="ocpf__dump_8h.html#aeb451b618b6e36b03799015b457094a6">OCPF_DUMP_TITLE</a>, and <a class="el" href="ocpf__dump_8h.html#a4723e75a8925192913e8035f152031f8">OCPF_DUMP_TOPLEVEL</a>.</p>
<p>Referenced by <a class="el" href="proto_8h.html#a2d0eedf8b9dadadf700dc9aa0342ce63">ocpf_dump()</a>.</p>
</div>
</div>
<a class="anchor" id="a3a8d8e8f032b00b4924047ba8e7f1805"></a><!-- doxytag: member="proto.h::ocpf_dump_property" ref="a3a8d8e8f032b00b4924047ba8e7f1805" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ void ocpf_dump_property </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="ocpf__dump_8h.html#a0fc095e9c8433e7f3538d3302958ef09">INDENT</a>, <a class="el" href="ocpf__dump_8h.html#a913a30aaae68bab9c263fd5208679335">indent</a>, <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a>, <a class="el" href="ocpf__dump_8h.html#aeb451b618b6e36b03799015b457094a6">OCPF_DUMP_TITLE</a>, and <a class="el" href="ocpf__dump_8h.html#a4723e75a8925192913e8035f152031f8">OCPF_DUMP_TOPLEVEL</a>.</p>
<p>Referenced by <a class="el" href="proto_8h.html#a2d0eedf8b9dadadf700dc9aa0342ce63">ocpf_dump()</a>.</p>
</div>
</div>
<a class="anchor" id="a65b1e863d68aa8fffb477e5c6c64f6cc"></a><!-- doxytag: member="proto.h::ocpf_dump_recipients" ref="a65b1e863d68aa8fffb477e5c6c64f6cc" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ocpf_dump_recipients </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Dump OCPF Recipients</p>
<p>Dump OCPF Recipients </p>
<p>References <a class="el" href="ocpf__dump_8h.html#a0fc095e9c8433e7f3538d3302958ef09">INDENT</a>, <a class="el" href="ocpf__dump_8h.html#a913a30aaae68bab9c263fd5208679335">indent</a>, <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a>, <a class="el" href="ocpf__dump_8h.html#aeb451b618b6e36b03799015b457094a6">OCPF_DUMP_TITLE</a>, and <a class="el" href="ocpf__dump_8h.html#a4723e75a8925192913e8035f152031f8">OCPF_DUMP_TOPLEVEL</a>.</p>
<p>Referenced by <a class="el" href="proto_8h.html#a2d0eedf8b9dadadf700dc9aa0342ce63">ocpf_dump()</a>.</p>
</div>
</div>
<a class="anchor" id="af98fd7149ec407cff0faff613434f0de"></a><!-- doxytag: member="proto.h::ocpf_dump_type" ref="af98fd7149ec407cff0faff613434f0de" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ocpf_dump_type </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Dump OCPF Type</p>
<p>Dump OCPF Registered Type </p>
<p>References <a class="el" href="ocpf__dump_8h.html#a0fc095e9c8433e7f3538d3302958ef09">INDENT</a>, <a class="el" href="ocpf__dump_8h.html#a913a30aaae68bab9c263fd5208679335">indent</a>, <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a>, <a class="el" href="ocpf__dump_8h.html#a8aa5991eea4e36fdb3f8b9c9ccff5a05">OCPF_DUMP</a>, <a class="el" href="ocpf__dump_8h.html#aeb451b618b6e36b03799015b457094a6">OCPF_DUMP_TITLE</a>, and <a class="el" href="ocpf__dump_8h.html#a4723e75a8925192913e8035f152031f8">OCPF_DUMP_TOPLEVEL</a>.</p>
<p>Referenced by <a class="el" href="proto_8h.html#a2d0eedf8b9dadadf700dc9aa0342ce63">ocpf_dump()</a>.</p>
</div>
</div>
<a class="anchor" id="abb50cb36ec43492a6149f81cf4c0d10b"></a><!-- doxytag: member="proto.h::ocpf_dump_variable" ref="abb50cb36ec43492a6149f81cf4c0d10b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ocpf_dump_variable </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="ocpf__dump_8h.html#a0fc095e9c8433e7f3538d3302958ef09">INDENT</a>, <a class="el" href="ocpf__dump_8h.html#a913a30aaae68bab9c263fd5208679335">indent</a>, <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a>, <a class="el" href="ocpf__dump_8h.html#aeb451b618b6e36b03799015b457094a6">OCPF_DUMP_TITLE</a>, and <a class="el" href="ocpf__dump_8h.html#a4723e75a8925192913e8035f152031f8">OCPF_DUMP_TOPLEVEL</a>.</p>
<p>Referenced by <a class="el" href="proto_8h.html#a2d0eedf8b9dadadf700dc9aa0342ce63">ocpf_dump()</a>.</p>
</div>
</div>
<a class="anchor" id="a1e6a64ad3406eeb8dfed6d4e2b953fb2"></a><!-- doxytag: member="proto.h::ocpf_get_SPropValue" ref="a1e6a64ad3406eeb8dfed6d4e2b953fb2" args="(uint32_t *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct SPropValue* ocpf_get_SPropValue </td>
<td>(</td>
<td class="paramtype">uint32_t * </td>
<td class="paramname"> <em>cValues</em></td>
<td> ) </td>
<td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the OCPF SPropValue array</p>
<p>This function is an accessor designed to return the SPropValue structure created with ocpf_set_SPropValue.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cValues</em> </td><td>pointer on the number of SPropValue entries</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>NULL on error, otherwise returns an allocated lpProps pointer</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="proto_8h.html#a8251ef359d0fa2736e7587a32cffabba">ocpf_set_SPropValue</a> </dd></dl>
<p>References <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a>.</p>
</div>
</div>
<a class="anchor" id="a5cef35bf5965c71d9b3b7b34031c6690"></a><!-- doxytag: member="proto.h::ocpf_init" ref="a5cef35bf5965c71d9b3b7b34031c6690" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__BEGIN_DECLS int ocpf_init </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize OCPF context</p>
<p>Initialize ocpf context and allocate memory for internal structures</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>OCPF_SUCCESS on success, otherwise OCPF_ERROR</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="proto_8h.html#a67c64196da27ef182d879db7f7eca25c">ocpf_release</a>, <a class="el" href="proto_8h.html#a932df66fbd1bec388b871dd4350f7285">ocpf_parse</a> </dd></dl>
<p>References <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a>.</p>
</div>
</div>
<a class="anchor" id="a56f8e60fea6226cebee5e902524c6bd2"></a><!-- doxytag: member="proto.h::ocpf_OpenFolder" ref="a56f8e60fea6226cebee5e902524c6bd2" args="(mapi_object_t *, mapi_object_t *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum MAPISTATUS ocpf_OpenFolder </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj_store</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj_folder</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open OCPF folder</p>
<p>This function opens the folder associated with the ocpf folder global context value.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>obj_store</em> </td><td>the store object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>obj_folder</em> </td><td>the folder to open</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI_E_NOT_FOUND.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Developers should call GetLastError() to retrieve the last MAPI error code. Possible MAPI error codes are:<ul>
<li>MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized.</li>
<li>MAPI_E_INVALID_PARAMETER: obj_store is undefined</li>
<li>MAPI_E_NOT_FOUND: The specified folder could not be found or is not yet supported.</li>
</ul>
</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="proto_8h.html#a5cef35bf5965c71d9b3b7b34031c6690">ocpf_init</a>, <a class="el" href="proto_8h.html#a932df66fbd1bec388b871dd4350f7285">ocpf_parse</a> </dd></dl>
<p>References <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a>.</p>
</div>
</div>
<a class="anchor" id="a932df66fbd1bec388b871dd4350f7285"></a><!-- doxytag: member="proto.h::ocpf_parse" ref="a932df66fbd1bec388b871dd4350f7285" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ocpf_parse </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filename</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse OCPF file</p>
<p>Parse and process the given ocpf file.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>the file to parse</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>OCPF_SUCCESS on success, otherwise OCPF_ERROR</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="proto_8h.html#a5cef35bf5965c71d9b3b7b34031c6690">ocpf_init</a> </dd></dl>
<p>References <a class="el" href="ocpf_8h.html#a4d5735b84109baf4680511fc3e34e4af">lineno</a>, <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a>, <a class="el" href="ocpf__public_8c.html#ad7a2e8ef89d9221c0bfa4486761ee3b0">ocpf_yyparse()</a>, and <a class="el" href="ocpf__public_8c.html#a46af646807e0797e72b6e8945e7ea88b">yyin</a>.</p>
</div>
</div>
<a class="anchor" id="a67c64196da27ef182d879db7f7eca25c"></a><!-- doxytag: member="proto.h::ocpf_release" ref="a67c64196da27ef182d879db7f7eca25c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ocpf_release </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Uninitialize OCPF context</p>
<p>Uninitialize the global OCPF context and release memory.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>OCPF_SUCCESS on success, otherwise OCPF_ERROR</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="proto_8h.html#a5cef35bf5965c71d9b3b7b34031c6690">ocpf_init</a> </dd></dl>
<p>References <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a>.</p>
</div>
</div>
<a class="anchor" id="aa45dd89024f37bbd36af6fed7f00a5c3"></a><!-- doxytag: member="proto.h::ocpf_set_Recipients" ref="aa45dd89024f37bbd36af6fed7f00a5c3" args="(TALLOC_CTX *, mapi_object_t *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum MAPISTATUS ocpf_set_Recipients </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_message</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 message recipients from ocpf context</p>
<p>This function sets the recipient (To, Cc, Bcc) from the ocpf context and information stored.</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> </td><td>the memory context to use for memory allocation </td></tr>
<tr><td valign="top"></td><td valign="top"><em>obj_message</em> </td><td>pointer to the message object we use for internal MAPI operations</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>OCPF_SUCCESS on success, otherwise OCPF_ERROR.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="ocpf__public_8c.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a> </dd></dl>
<p>References <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a>.</p>
</div>
</div>
<a class="anchor" id="a8251ef359d0fa2736e7587a32cffabba"></a><!-- doxytag: member="proto.h::ocpf_set_SPropValue" ref="a8251ef359d0fa2736e7587a32cffabba" args="(TALLOC_CTX *, mapi_object_t *obj_folder, mapi_object_t *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum MAPISTATUS ocpf_set_SPropValue </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_folder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj_message</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Build a SPropValue array from ocpf context</p>
<p>This function builds a SPropValue array from the ocpf context and information stored.</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> </td><td>the memory context to use for memory allocation </td></tr>
<tr><td valign="top"></td><td valign="top"><em>obj_folder</em> </td><td>pointer the folder object we use for internal MAPI operations </td></tr>
<tr><td valign="top"></td><td valign="top"><em>obj_message</em> </td><td>pointer to the message object we use for internal MAPI operations</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise -1.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Developers should call GetLastError() 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"><dt><b>See also:</b></dt><dd><a class="el" href="proto_8h.html#a1e6a64ad3406eeb8dfed6d4e2b953fb2">ocpf_get_SPropValue</a> </dd></dl>
<p>References <a class="el" href="ocpf__public_8c.html#a6a92c281d7a60ee42f44160e14f5aba6">MAX_READ_SIZE</a>, and <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a>.</p>
</div>
</div>
<a class="anchor" id="a92380028e4063628979a2b964949deeb"></a><!-- doxytag: member="proto.h::ocpf_write_auto" ref="a92380028e4063628979a2b964949deeb" args="(mapi_object_t *, struct mapi_SPropValue_array *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ int ocpf_write_auto </td>
<td>(</td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj_message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct mapi_SPropValue_array * </td>
<td class="paramname"> <em>mapi_lpProps</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create the OCPF structure required for the commit operation</p>
<p>This function process properties and named properties from the specified mapi_SPropValue_array and generates an OCPF structure with all the attributes required to create an OCPF file in the commit operation.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>obj_message</em> </td><td>the message object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mapi_lpProps</em> </td><td>the array of mapi properties returned by GetPropsAll</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>OCPF_SUCCESS on success, otherwise OCPF_ERROR</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>GetPropsAll, <a class="el" href="proto_8h.html#a2cef081b58d0fb7cc37beb2ac701476f">ocpf_write_commit</a> </dd></dl>
<p>References <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a>, and <a class="el" href="ocpf_8h.html#a7e7d1caafda374f8ac67bd96b6d8bb90">OCPF_SUCCESS</a>.</p>
</div>
</div>
<a class="anchor" id="a2cef081b58d0fb7cc37beb2ac701476f"></a><!-- doxytag: member="proto.h::ocpf_write_commit" ref="a2cef081b58d0fb7cc37beb2ac701476f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ int ocpf_write_commit </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write OCPF structure to OCPF file</p>
<p>This function dumps the OCPF structure content into the OCPF file defined in ocpf_write_init.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>OCPF_SUCCESS on success, otherwise OCPF_ERROR</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="proto_8h.html#a29356f0b1be1837c516bd19deea13376">ocpf_write_init</a>, <a class="el" href="proto_8h.html#a92380028e4063628979a2b964949deeb">ocpf_write_auto</a> </dd></dl>
<p>References <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</a>.</p>
</div>
</div>
<a class="anchor" id="a29356f0b1be1837c516bd19deea13376"></a><!-- doxytag: member="proto.h::ocpf_write_init" ref="a29356f0b1be1837c516bd19deea13376" args="(const char *, mapi_id_t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ int ocpf_write_init </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mapi_id_t </td>
<td class="paramname"> <em>folder_id</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Specify the OCPF file name to write</p>
<p>Specify the ocpf file to create</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>output filename </td></tr>
<tr><td valign="top"></td><td valign="top"><em>folder_id</em> </td><td>the folder</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>OCPF_SUCCESS on success, otherwise OCPF_ERROR</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="proto_8h.html#a5cef35bf5965c71d9b3b7b34031c6690">ocpf_init</a> </dd></dl>
<p>References <a class="el" href="ocpf_8h.html#ad2d4839c05f97a79638401a78fa07bf7">ocpf</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>
