<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="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>libocpf/ocpf_write.c File Reference</h1> </div>
</div>
<div class="contents">
<p>public OCPF write API
<a href="#_details">More...</a></p>
<code>#include "libocpf/ocpf_private.h"</code><br/>
<code>#include <<a class="el" href="ocpf_8h.html">libocpf/ocpf.h</a>></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_ int </td><td class="memItemRight" valign="bottom"><a class="el" href="ocpf__write_8c.html#a789f90062bfe672ea0ff2fb19504b26a">ocpf_write_auto</a> (mapi_object_t *obj_message, struct mapi_SPropValue_array *mapi_lpProps)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ int </td><td class="memItemRight" valign="bottom"><a class="el" href="ocpf__write_8c.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="ocpf__write_8c.html#abb53ce2e0a2d48cbf7c9d43e1b403a87">ocpf_write_init</a> (const char *filename, mapi_id_t folder_id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ocpf__write_8c.html#a22820bcb1344d95d1edb99e8c13752e2">ocpf_write_unescape_string</a> (const char *value)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>public OCPF write API </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a789f90062bfe672ea0ff2fb19504b26a"></a><!-- doxytag: member="ocpf_write.c::ocpf_write_auto" ref="a789f90062bfe672ea0ff2fb19504b26a" args="(mapi_object_t *obj_message, struct mapi_SPropValue_array *mapi_lpProps)" -->
<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="ocpf_write.c::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="abb53ce2e0a2d48cbf7c9d43e1b403a87"></a><!-- doxytag: member="ocpf_write.c::ocpf_write_init" ref="abb53ce2e0a2d48cbf7c9d43e1b403a87" args="(const char *filename, mapi_id_t folder_id)" -->
<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>
<a class="anchor" id="a22820bcb1344d95d1edb99e8c13752e2"></a><!-- doxytag: member="ocpf_write.c::ocpf_write_unescape_string" ref="a22820bcb1344d95d1edb99e8c13752e2" args="(const char *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* ocpf_write_unescape_string </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
