<html>
<head>
<title>OpenChange Property Files 0.8 API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<link href="apidocs.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="website">
<div class="header"></div>
<div id="middle_side">
<div id="right_side_home">
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>libocpf/ocpf_public.c File Reference</h1>public OCPF API
<a href="#_details">More...</a>
<p>
<code>#include "libocpf/ocpf_private.h"</code><br>
<code>#include <libocpf/ocpf.h></code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ struct SPropValue * </td><td class="memItemRight" valign="bottom"><a class="el" href="ocpf__public_8c.html#ad0ea96d742e6a34da9a723a217b4aef">ocpf_get_SPropValue</a> (uint32_t *cValues)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ int </td><td class="memItemRight" valign="bottom"><a class="el" href="ocpf__public_8c.html#3d8b443869a67afd0d70cce08b6f6c3b">ocpf_init</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="ocpf__public_8c.html#d9917a2b3e74eec7cee6b383e8b73ec3">ocpf_OpenFolder</a> (mapi_object_t *obj_store, mapi_object_t *obj_folder)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ int </td><td class="memItemRight" valign="bottom"><a class="el" href="ocpf__public_8c.html#54e0c768891d33de58c1b2acdc7aec4c">ocpf_parse</a> (const char *filename)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ int </td><td class="memItemRight" valign="bottom"><a class="el" href="ocpf__public_8c.html#dfabda1510aabf612fa5dbe15d489536">ocpf_release</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="ocpf__public_8c.html#04db4561147f69b11b1d13f38adb0660">ocpf_set_Recipients</a> (TALLOC_CTX *mem_ctx, mapi_object_t *obj_message)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="ocpf__public_8c.html#1850beb9c9fcec30b9a5c70f83e709ad">ocpf_set_SPropValue</a> (TALLOC_CTX *mem_ctx, mapi_object_t *obj_folder, mapi_object_t *obj_message)</td></tr>
</table>
<hr><h2>Detailed Description</h2>
public OCPF API
<p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="ad0ea96d742e6a34da9a723a217b4aef"></a><!-- doxytag: member="ocpf_public.c::ocpf_get_SPropValue" ref="ad0ea96d742e6a34da9a723a217b4aef" args="(uint32_t *cValues)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ 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>
This function is an accessor designed to return the SPropValue structure created with ocpf_set_SPropValue.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cValues</em> </td><td>pointer on the number of SPropValue entries</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL on error, otherwise returns an allocated lpProps pointer</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="ocpf__public_8c.html#1850beb9c9fcec30b9a5c70f83e709ad">ocpf_set_SPropValue</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="3d8b443869a67afd0d70cce08b6f6c3b"></a><!-- doxytag: member="ocpf_public.c::ocpf_init" ref="3d8b443869a67afd0d70cce08b6f6c3b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ 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>
Initialize ocpf context and allocate memory for internal structures<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>OCPF_SUCCESS on success, otherwise OCPF_ERROR</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="ocpf__public_8c.html#dfabda1510aabf612fa5dbe15d489536">ocpf_release</a>, <a class="el" href="ocpf__public_8c.html#54e0c768891d33de58c1b2acdc7aec4c">ocpf_parse</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="d9917a2b3e74eec7cee6b383e8b73ec3"></a><!-- doxytag: member="ocpf_public.c::ocpf_OpenFolder" ref="d9917a2b3e74eec7cee6b383e8b73ec3" args="(mapi_object_t *obj_store, mapi_object_t *obj_folder)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ 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>
This function opens the folder associated with the ocpf folder global context value.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI_E_NOT_FOUND.</dd></dl>
<dl class="note" compact><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" compact><dt><b>See also:</b></dt><dd><a class="el" href="ocpf__public_8c.html#3d8b443869a67afd0d70cce08b6f6c3b">ocpf_init</a>, <a class="el" href="ocpf__public_8c.html#54e0c768891d33de58c1b2acdc7aec4c">ocpf_parse</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="54e0c768891d33de58c1b2acdc7aec4c"></a><!-- doxytag: member="ocpf_public.c::ocpf_parse" ref="54e0c768891d33de58c1b2acdc7aec4c" args="(const char *filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ 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>
Parse and process the given ocpf file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>the file to parse</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>OCPF_SUCCESS on success, otherwise OCPF_ERROR</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="ocpf__public_8c.html#3d8b443869a67afd0d70cce08b6f6c3b">ocpf_init</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="dfabda1510aabf612fa5dbe15d489536"></a><!-- doxytag: member="ocpf_public.c::ocpf_release" ref="dfabda1510aabf612fa5dbe15d489536" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ 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>
Uninitialize the global OCPF context and release memory.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>OCPF_SUCCESS on success, otherwise OCPF_ERROR</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="ocpf__public_8c.html#3d8b443869a67afd0d70cce08b6f6c3b">ocpf_init</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="04db4561147f69b11b1d13f38adb0660"></a><!-- doxytag: member="ocpf_public.c::ocpf_set_Recipients" ref="04db4561147f69b11b1d13f38adb0660" args="(TALLOC_CTX *mem_ctx, mapi_object_t *obj_message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ 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>
This function sets the recipient (To, Cc, Bcc) from the ocpf context and information stored.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mem_ctx</em> </td><td>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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>OCPF_SUCCESS on success, otherwise OCPF_ERROR.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd>ocpf </dd></dl>
</div>
</div><p>
<a class="anchor" name="1850beb9c9fcec30b9a5c70f83e709ad"></a><!-- doxytag: member="ocpf_public.c::ocpf_set_SPropValue" ref="1850beb9c9fcec30b9a5c70f83e709ad" args="(TALLOC_CTX *mem_ctx, mapi_object_t *obj_folder, mapi_object_t *obj_message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ 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>
This function builds a SPropValue array from the ocpf context and information stored.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mem_ctx</em> </td><td>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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise -1.</dd></dl>
<dl class="note" compact><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" compact><dt><b>See also:</b></dt><dd><a class="el" href="ocpf__public_8c.html#ad0ea96d742e6a34da9a723a217b4aef">ocpf_get_SPropValue</a> </dd></dl>
</div>
</div><p>
</div>
</div>
<br/>
<table style="clear:both; margin: 0.5em auto; width:80%; text-align: center; background-color:#f8f8f8; border:2px solid #e0e0e0; padding:5px;">
<tr>
<td>
<img alt="Creative Commons License" src="CC_SomeRightsReserved.png" width="90" height="30" border="0" /><br />
<img alt="Creative Commons Attribution icon" src="24px-Cc-by_white.svg.png" width="24" height="24" border="0" />
<img alt="Creative Commons Share Alike icon" src="24px-Cc-sa_white.svg.png" width="24" height="24" border="0" />
</td>
<td> <i><strong class="selflink">This content</strong> is licensed under the Creative Commons<br />
Attribution ShareAlike License v. 3.0:<br />
<a href="http://creativecommons.org/licenses/by-sa/3.0/" class="external free" title="http://creativecommons.org/licenses/by-sa/3.0/" rel="nofollow">http://creativecommons.org/licenses/by-sa/3.0/</a></i>
</td></tr></table>
<br/>
</div>
</div>
</body>
</html>
