<html>
<head>
<title>MAPIClientLibraries 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><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data 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="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>libmapi/property.c File Reference</h1>Functions for manipulating MAPI properties.
<a href="#_details">More...</a>
<p>
<code>#include <libmapi/libmapi.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 GlobalObjectId * </td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#ae3d014deb6eef2a2ba662321652fb01">get_GlobalObjectId</a> (TALLOC_CTX *mem_ctx, struct Binary_r *bin)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ struct RecurrencePattern * </td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#e3bd3973e59b5a3a17f239176c551463">get_RecurrencePattern</a> (TALLOC_CTX *mem_ctx, struct Binary_r *bin)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ struct TimeZoneStruct * </td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#8cefc73e7ac8f6a0e972be515b3a1249">get_TimeZoneStruct</a> (TALLOC_CTX *mem_ctx, struct Binary_r *bin)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#32a65292c776e8d0dfca51e404e6936d">SPropTagArray_add</a> (TALLOC_CTX *mem_ctx, struct SPropTagArray *SPropTagArray, uint32_t aulPropTag)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#6d194c81bb999f8cf188e8afc164c153">SRow_addprop</a> (struct SRow *aRow, struct SPropValue SPropValue)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#5da680833efafe1c5b5306122f39987f">SRowSet_propcpy</a> (TALLOC_CTX *mem_ctx, struct SRowSet *SRowSet, struct SPropValue SPropValue)</td></tr>
</table>
<hr><h2>Detailed Description</h2>
Functions for manipulating MAPI properties.
<p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="ae3d014deb6eef2a2ba662321652fb01"></a><!-- doxytag: member="property.c::get_GlobalObjectId" ref="ae3d014deb6eef2a2ba662321652fb01" args="(TALLOC_CTX *mem_ctx, struct Binary_r *bin)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ struct GlobalObjectId* get_GlobalObjectId </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">struct Binary_r * </td>
<td class="paramname"> <em>bin</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve a GlobalObjectId structure from a binary blob<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>pointer to the memory context </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bin</em> </td><td>pointer to the Binary_r structure with raw GlobalObjectId data</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Allocated GlobalObjectId structure on success, otherwise NULL</dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Developers must free the allocated GlobalObjectId when finished. </dd></dl>
</div>
</div><p>
<a class="anchor" name="e3bd3973e59b5a3a17f239176c551463"></a><!-- doxytag: member="property.c::get_RecurrencePattern" ref="e3bd3973e59b5a3a17f239176c551463" args="(TALLOC_CTX *mem_ctx, struct Binary_r *bin)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ struct RecurrencePattern* get_RecurrencePattern </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">struct Binary_r * </td>
<td class="paramname"> <em>bin</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve a RecurrencePattern structure from a binary blob<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>pointer to the memory context </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bin</em> </td><td>pointer to the Binary_r structure with non-mapped reccurrence data</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Allocated RecurrencePattern structure on success, otherwise NULL</dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Developers must free the allocated RecurrencePattern when finished. </dd></dl>
</div>
</div><p>
<a class="anchor" name="8cefc73e7ac8f6a0e972be515b3a1249"></a><!-- doxytag: member="property.c::get_TimeZoneStruct" ref="8cefc73e7ac8f6a0e972be515b3a1249" args="(TALLOC_CTX *mem_ctx, struct Binary_r *bin)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ struct TimeZoneStruct* get_TimeZoneStruct </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">struct Binary_r * </td>
<td class="paramname"> <em>bin</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve a TimeZoneStruct structure from a binary blob<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>pointer to the memory context </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bin</em> </td><td>pointer to the Binary_r structure with raw TimeZoneStruct data</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Allocated TimeZoneStruct structure on success, otherwise NULL</dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Developers must free the allocated TimeZoneStruct when finished. </dd></dl>
</div>
</div><p>
<a class="anchor" name="32a65292c776e8d0dfca51e404e6936d"></a><!-- doxytag: member="property.c::SPropTagArray_add" ref="32a65292c776e8d0dfca51e404e6936d" args="(TALLOC_CTX *mem_ctx, struct SPropTagArray *SPropTagArray, uint32_t aulPropTag)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS SPropTagArray_add </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">struct SPropTagArray * </td>
<td class="paramname"> <em>SPropTagArray</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>aulPropTag</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a property tag to an existing properties array<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>talloc memory context to use for allocation </td></tr>
<tr><td valign="top"></td><td valign="top"><em>SPropTagArray</em> </td><td>existing properties array to add to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aulPropTag</em> </td><td>the property tag to add</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Possible MAPI error codes are:<ul>
<li>MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized</li><li>MAPI_E_INVALID_PARAMETER: SPropTagArray parameter is not correctly set </li></ul>
</dd></dl>
<p>Referenced by <a class="el" href="IMessage_8c_source.html#l01408">OpenEmbeddedMessage()</a>, and <a class="el" href="IStoreFolder_8c_source.html#l00061">OpenMessage()</a>.</p>
</div>
</div><p>
<a class="anchor" name="6d194c81bb999f8cf188e8afc164c153"></a><!-- doxytag: member="property.c::SRow_addprop" ref="6d194c81bb999f8cf188e8afc164c153" args="(struct SRow *aRow, struct SPropValue SPropValue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS SRow_addprop </td>
<td>(</td>
<td class="paramtype">struct SRow * </td>
<td class="paramname"> <em>aRow</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct SPropValue SPropValue </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
add a SPropValue structure to a SRow array<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>aRow</em> </td><td>pointer to the SRow array where SPropBalue should be appended </td></tr>
<tr><td valign="top"></td><td valign="top"><em>SPropValue</em> </td><td>reference to the SPropValue structure to add to aRow</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI_E_INVALID_PARAMETER. </dd></dl>
<p>Referenced by <a class="el" href="IMessage_8c_source.html#l01408">OpenEmbeddedMessage()</a>, <a class="el" href="IStoreFolder_8c_source.html#l00061">OpenMessage()</a>, and <a class="el" href="IMessage_8c_source.html#l00412">SetRecipientType()</a>.</p>
</div>
</div><p>
<a class="anchor" name="5da680833efafe1c5b5306122f39987f"></a><!-- doxytag: member="property.c::SRowSet_propcpy" ref="5da680833efafe1c5b5306122f39987f" args="(TALLOC_CTX *mem_ctx, struct SRowSet *SRowSet, struct SPropValue SPropValue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ uint32_t SRowSet_propcpy </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">struct SRowSet * </td>
<td class="paramname"> <em>SRowSet</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct SPropValue SPropValue </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Append a SPropValue structure to given SRowSet<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>pointer to the memory context </td></tr>
<tr><td valign="top"></td><td valign="top"><em>SRowSet</em> </td><td>pointer to the SRowSet array to update </td></tr>
<tr><td valign="top"></td><td valign="top"><em>SPropValue</em> </td><td>the SPropValue to append within SRowSet</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, otherwise 1 </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>
