← Back to branch summary

~ubuntu-branches/debian/sid/openchange/sid

« back to all changes in this revision

Viewing changes to apidocs/html/libmapi/property_8c.html

  • Committer: Package Import Robot
  • Author(s): Jelmer Vernooij
  • Date: 2014-04-24 00:29:19 UTC
  • mfrom: (1.2.8) (4.1.6 experimental)
  • Revision ID: package-import@ubuntu.com-20140424002919-96es5uhyy3jjzgid
Tags: 1:2.1-1
* New upstream release.
 + Stop removing broken manpages, upstream on longer installs them.
* Add upstream signing key.
* Run test suite during build.
 + Add dependency on python-twisted-core for trial and python-testtools.
 + Add fix-tests patch, cherry-picked from upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
apidocs/html/libmapi/property_8c.html
1
 
<html>
2
 
  <head>
3
 
    <title>MAPIClientLibraries 2.0 API Documentation</title>
4
 
    <link href="doxygen.css" rel="stylesheet" type="text/css"/>
5
 
    <link href="apidocs.css" rel="stylesheet" type="text/css"/>
6
 
  </head>
7
 
  <body>
8
 
    <div id="website">
9
 
    <div class="header"></div>
10
 
      <div id="middle_side">
11
 
        <div id="right_side_home">
12
 
<!-- Generated by Doxygen 1.8.1.2 -->
13
 
  <div id="navrow1" class="tabs">
14
 
    <ul class="tablist">
15
 
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
16
 
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
17
 
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
18
 
      <li class="current"><a href="files.html"><span>Files</span></a></li>
19
 
      <li><a href="examples.html"><span>Examples</span></a></li>
20
 
    </ul>
21
 
  </div>
22
 
  <div id="navrow2" class="tabs2">
23
 
    <ul class="tablist">
24
 
      <li><a href="files.html"><span>File&#160;List</span></a></li>
25
 
      <li><a href="globals.html"><span>Globals</span></a></li>
26
 
    </ul>
27
 
  </div>
28
 
<div id="nav-path" class="navpath">
29
 
  <ul>
30
 
<li class="navelem"><a class="el" href="dir_f632a44caec7a90b6d38c87e3df284e5.html">libmapi</a></li>  </ul>
31
 
</div>
32
 
</div><!-- top -->
33
 
<div class="header">
34
 
  <div class="summary">
35
 
<a href="#func-members">Functions</a>  </div>
36
 
  <div class="headertitle">
37
 
<div class="title">property.c File Reference</div>  </div>
38
 
</div><!--header-->
39
 
<div class="contents">
40
 
 
41
 
<p>Functions for manipulating MAPI properties.  
42
 
<a href="#details">More...</a></p>
43
 
<div class="textblock"><code>#include &quot;libmapi/libmapi.h&quot;</code><br/>
44
 
<code>#include &quot;libmapi/libmapi_private.h&quot;</code><br/>
45
 
</div><table class="memberdecls">
46
 
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
47
 
Functions</h2></td></tr>
48
 
<tr class="memitem:a70f67e9d21b97a881b56f3b44b2dd282"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#a70f67e9d21b97a881b56f3b44b2dd282">cast_mapi_SPropValue</a> (TALLOC_CTX *mem_ctx, struct mapi_SPropValue *mapi_sprop, struct SPropValue *sprop)</td></tr>
49
 
<tr class="memitem:a4ca8f0e75264fec83933df8bcf6e60e1"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#a4ca8f0e75264fec83933df8bcf6e60e1">cast_PropertyRow_to_SRow</a> (TALLOC_CTX *mem_ctx, struct PropertyRow_r *proprow, struct SRow *srow)</td></tr>
50
 
<tr class="memitem:a1deb82cd518f5a870da7ec36debb394c"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#a1deb82cd518f5a870da7ec36debb394c">cast_PropertyRowSet_to_SRowSet</a> (TALLOC_CTX *mem_ctx, struct PropertyRowSet_r *prowset, struct SRowSet *srowset)</td></tr>
51
 
<tr class="memitem:aa503d2a29dd9734136c82afb6b151dfd"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#aa503d2a29dd9734136c82afb6b151dfd">cast_PropertyValue_to_SPropValue</a> (struct PropertyValue_r *propvalue, struct SPropValue *spropvalue)</td></tr>
52
 
<tr class="memitem:ac4cc3391330aae4641c05a510b891da9"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#ac4cc3391330aae4641c05a510b891da9">cast_SPropValue</a> (TALLOC_CTX *mem_ctx, struct mapi_SPropValue *mapi_sprop, struct SPropValue *sprop)</td></tr>
53
 
<tr class="memitem:ac7d9e04c25f0030a7495b21effd3df29"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ struct <br class="typebreak"/>
54
 
AddressBookEntryId *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#ac7d9e04c25f0030a7495b21effd3df29">get_AddressBookEntryId</a> (TALLOC_CTX *mem_ctx, struct Binary_r *bin)</td></tr>
55
 
<tr class="memitem:ae12bf1c63d16c4093fe05ce252d9cd27"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ struct FolderEntryId *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#ae12bf1c63d16c4093fe05ce252d9cd27">get_FolderEntryId</a> (TALLOC_CTX *mem_ctx, struct Binary_r *bin)</td></tr>
56
 
<tr class="memitem:aae3d014deb6eef2a2ba662321652fb01"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ struct GlobalObjectId *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#aae3d014deb6eef2a2ba662321652fb01">get_GlobalObjectId</a> (TALLOC_CTX *mem_ctx, struct Binary_r *bin)</td></tr>
57
 
<tr class="memitem:ab6d9d832a62f28e9dfa75de0bef677e9"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ struct MessageEntryId *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#ab6d9d832a62f28e9dfa75de0bef677e9">get_MessageEntryId</a> (TALLOC_CTX *mem_ctx, struct Binary_r *bin)</td></tr>
58
 
<tr class="memitem:a6f102b15c3af5deec56aeecc22635824"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ struct PtypServerId *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#a6f102b15c3af5deec56aeecc22635824">get_PtypServerId</a> (TALLOC_CTX *mem_ctx, struct Binary_r *bin)</td></tr>
59
 
<tr class="memitem:ae3bd3973e59b5a3a17f239176c551463"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ struct RecurrencePattern *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#ae3bd3973e59b5a3a17f239176c551463">get_RecurrencePattern</a> (TALLOC_CTX *mem_ctx, struct Binary_r *bin)</td></tr>
60
 
<tr class="memitem:a8cefc73e7ac8f6a0e972be515b3a1249"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ struct TimeZoneStruct *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#a8cefc73e7ac8f6a0e972be515b3a1249">get_TimeZoneStruct</a> (TALLOC_CTX *mem_ctx, struct Binary_r *bin)</td></tr>
61
 
<tr class="memitem:a2393ff08f055915dabb95b8b6c13677f"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#a2393ff08f055915dabb95b8b6c13677f">get_TypedString</a> (struct TypedString *tstring)</td></tr>
62
 
<tr class="memitem:a41cb1aa9af66195a07acea1d0f848a3a"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#a41cb1aa9af66195a07acea1d0f848a3a">get_utf8_utf16_conv_length</a> (const char *inbuf)</td></tr>
63
 
<tr class="memitem:aa640ff2bdce68e12dd579981a94487f7"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#aa640ff2bdce68e12dd579981a94487f7">mapi_copy_spropvalues</a> (TALLOC_CTX *mem_ctx, struct SPropValue *source_values, struct SPropValue *dest_values, uint32_t count)</td></tr>
64
 
<tr class="memitem:ac9c73f628a128cc4c4fa1d92f53e1d05"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#ac9c73f628a128cc4c4fa1d92f53e1d05">PropertyRow_addprop</a> (struct PropertyRow_r *aRow, struct PropertyValue_r propValue)</td></tr>
65
 
<tr class="memitem:a16e519b5740026cdc4ba61a867445db3"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#a16e519b5740026cdc4ba61a867445db3">PropertyRowSet_propcpy</a> (TALLOC_CTX *mem_ctx, struct PropertyRowSet_r *RowSet, struct PropertyValue_r value)</td></tr>
66
 
<tr class="memitem:a08d81a8e5a6ec970d5ff891e325de402"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ struct SPropTagArray *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#a08d81a8e5a6ec970d5ff891e325de402">set_SPropTagArray</a> (TALLOC_CTX *mem_ctx, uint32_t PropCount,...)</td></tr>
67
 
<tr class="memitem:a1a74a2f9bad1de37fa07ff51707473a1"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#a1a74a2f9bad1de37fa07ff51707473a1">SPropTagArray_add</a> (TALLOC_CTX *mem_ctx, struct SPropTagArray *SPropTagArray, enum MAPITAGS aulPropTag)</td></tr>
68
 
<tr class="memitem:a67e3ce67f22d6803a33b1ae1ad794c8c"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#a67e3ce67f22d6803a33b1ae1ad794c8c">SPropTagArray_delete</a> (TALLOC_CTX *mem_ctx, struct SPropTagArray *SPropTagArray, uint32_t aulPropTag)</td></tr>
69
 
<tr class="memitem:aa7d5460810482491c5829c4b6be2fe8f"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#aa7d5460810482491c5829c4b6be2fe8f">SPropTagArray_find</a> (struct SPropTagArray SPropTagArray, enum MAPITAGS aulPropTag, uint32_t *propIdx)</td></tr>
70
 
<tr class="memitem:a4aeef6cda2c452388ab2b2865efa6627"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#a4aeef6cda2c452388ab2b2865efa6627">SRow_addprop</a> (struct SRow *aRow, struct SPropValue spropvalue)</td></tr>
71
 
<tr class="memitem:a786b1f3480dfa430b3e361d4de4770e2"><td class="memItemLeft" align="right" valign="top">_PUBLIC_ uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="property_8c.html#a786b1f3480dfa430b3e361d4de4770e2">SRowSet_propcpy</a> (TALLOC_CTX *mem_ctx, struct SRowSet *SRowSet, struct SPropValue spropvalue)</td></tr>
72
 
</table>
73
 
<a name="details" id="details"></a><h2>Detailed Description</h2>
74
 
<div class="textblock"><p>Functions for manipulating MAPI properties. </p>
75
 
</div><h2>Function Documentation</h2>
76
 
<a class="anchor" id="a70f67e9d21b97a881b56f3b44b2dd282"></a>
77
 
<div class="memitem">
78
 
<div class="memproto">
79
 
      <table class="memname">
80
 
        <tr>
81
 
          <td class="memname">_PUBLIC_ uint32_t cast_mapi_SPropValue </td>
82
 
          <td>(</td>
83
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
84
 
          <td class="paramname"><em>mem_ctx</em>, </td>
85
 
        </tr>
86
 
        <tr>
87
 
          <td class="paramkey"></td>
88
 
          <td></td>
89
 
          <td class="paramtype">struct mapi_SPropValue *&#160;</td>
90
 
          <td class="paramname"><em>mapi_sprop</em>, </td>
91
 
        </tr>
92
 
        <tr>
93
 
          <td class="paramkey"></td>
94
 
          <td></td>
95
 
          <td class="paramtype">struct SPropValue *&#160;</td>
96
 
          <td class="paramname"><em>sprop</em>&#160;</td>
97
 
        </tr>
98
 
        <tr>
99
 
          <td></td>
100
 
          <td>)</td>
101
 
          <td></td><td></td>
102
 
        </tr>
103
 
      </table>
104
 
</div><div class="memdoc">
105
 
<p>Convenience function to convert a SPropValue structure into a mapi_SPropValue structure and return the associated size.</p>
106
 
<dl class="params"><dt>Parameters</dt><dd>
107
 
  <table class="params">
108
 
    <tr><td class="paramname">mem_ctx</td><td>pointer to the memory context to use for allocation </td></tr>
109
 
    <tr><td class="paramname">mapi_sprop</td><td>pointer to the MAPI SPropValue structure to copy data to </td></tr>
110
 
    <tr><td class="paramname">sprop</td><td>pointer to the SPropValue structure to copy data from</td></tr>
111
 
  </table>
112
 
  </dd>
113
 
</dl>
114
 
<dl class="section return"><dt>Returns</dt><dd>size of the converted data on success, otherwise 0 </dd></dl>
115
 
 
116
 
<p>References <a class="el" href="property_8c.html#a41cb1aa9af66195a07acea1d0f848a3a">get_utf8_utf16_conv_length()</a>.</p>
117
 
 
118
 
<p>Referenced by <a class="el" href="IMessage_8c.html#a2631355714b42d3d972113372c5175e0">ModifyRecipients()</a>, <a class="el" href="IMAPIProp_8c.html#a5132fc4cccdbf65b9156fe1ae6bb187f">SetPropertiesNoReplicate()</a>, and <a class="el" href="IMAPIProp_8c.html#a493019f7bf3431d246b1e3a6b3114084">SetProps()</a>.</p>
119
 
 
120
 
</div>
121
 
</div>
122
 
<a class="anchor" id="a4ca8f0e75264fec83933df8bcf6e60e1"></a>
123
 
<div class="memitem">
124
 
<div class="memproto">
125
 
      <table class="memname">
126
 
        <tr>
127
 
          <td class="memname">_PUBLIC_ void cast_PropertyRow_to_SRow </td>
128
 
          <td>(</td>
129
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
130
 
          <td class="paramname"><em>mem_ctx</em>, </td>
131
 
        </tr>
132
 
        <tr>
133
 
          <td class="paramkey"></td>
134
 
          <td></td>
135
 
          <td class="paramtype">struct PropertyRow_r *&#160;</td>
136
 
          <td class="paramname"><em>proprow</em>, </td>
137
 
        </tr>
138
 
        <tr>
139
 
          <td class="paramkey"></td>
140
 
          <td></td>
141
 
          <td class="paramtype">struct SRow *&#160;</td>
142
 
          <td class="paramname"><em>srow</em>&#160;</td>
143
 
        </tr>
144
 
        <tr>
145
 
          <td></td>
146
 
          <td>)</td>
147
 
          <td></td><td></td>
148
 
        </tr>
149
 
      </table>
150
 
</div><div class="memdoc">
151
 
<p>Convenience function to convert a PropertyRow_r structure into a SRow structure.</p>
152
 
<dl class="params"><dt>Parameters</dt><dd>
153
 
  <table class="params">
154
 
    <tr><td class="paramname">mem_ctx</td><td>pointer to the allocation context for structure members </td></tr>
155
 
    <tr><td class="paramname">proprow</td><td>pointer to the PropertyRow_r structure to copy data to </td></tr>
156
 
    <tr><td class="paramname">srow</td><td>pointer to the SRow structure to copy data from </td></tr>
157
 
  </table>
158
 
  </dd>
159
 
</dl>
160
 
 
161
 
<p>References <a class="el" href="property_8c.html#aa503d2a29dd9734136c82afb6b151dfd">cast_PropertyValue_to_SPropValue()</a>.</p>
162
 
 
163
 
<p>Referenced by <a class="el" href="property_8c.html#a1deb82cd518f5a870da7ec36debb394c">cast_PropertyRowSet_to_SRowSet()</a>.</p>
164
 
 
165
 
</div>
166
 
</div>
167
 
<a class="anchor" id="a1deb82cd518f5a870da7ec36debb394c"></a>
168
 
<div class="memitem">
169
 
<div class="memproto">
170
 
      <table class="memname">
171
 
        <tr>
172
 
          <td class="memname">_PUBLIC_ void cast_PropertyRowSet_to_SRowSet </td>
173
 
          <td>(</td>
174
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
175
 
          <td class="paramname"><em>mem_ctx</em>, </td>
176
 
        </tr>
177
 
        <tr>
178
 
          <td class="paramkey"></td>
179
 
          <td></td>
180
 
          <td class="paramtype">struct PropertyRowSet_r *&#160;</td>
181
 
          <td class="paramname"><em>prowset</em>, </td>
182
 
        </tr>
183
 
        <tr>
184
 
          <td class="paramkey"></td>
185
 
          <td></td>
186
 
          <td class="paramtype">struct SRowSet *&#160;</td>
187
 
          <td class="paramname"><em>srowset</em>&#160;</td>
188
 
        </tr>
189
 
        <tr>
190
 
          <td></td>
191
 
          <td>)</td>
192
 
          <td></td><td></td>
193
 
        </tr>
194
 
      </table>
195
 
</div><div class="memdoc">
196
 
<p>Convenience function to convert a PropertyRowSet_r structure into a SRowSet structure.</p>
197
 
<dl class="params"><dt>Parameters</dt><dd>
198
 
  <table class="params">
199
 
    <tr><td class="paramname">mem_ctx</td><td>pointer to the allocation context for structure members </td></tr>
200
 
    <tr><td class="paramname">prowset</td><td>pointer to the PropertyRowSet_r structure to copy data to </td></tr>
201
 
    <tr><td class="paramname">setrowset</td><td>pointer to the SRowSet structure to copy data from </td></tr>
202
 
  </table>
203
 
  </dd>
204
 
</dl>
205
 
 
206
 
<p>References <a class="el" href="property_8c.html#a4ca8f0e75264fec83933df8bcf6e60e1">cast_PropertyRow_to_SRow()</a>.</p>
207
 
 
208
 
</div>
209
 
</div>
210
 
<a class="anchor" id="aa503d2a29dd9734136c82afb6b151dfd"></a>
211
 
<div class="memitem">
212
 
<div class="memproto">
213
 
      <table class="memname">
214
 
        <tr>
215
 
          <td class="memname">_PUBLIC_ void cast_PropertyValue_to_SPropValue </td>
216
 
          <td>(</td>
217
 
          <td class="paramtype">struct PropertyValue_r *&#160;</td>
218
 
          <td class="paramname"><em>propvalue</em>, </td>
219
 
        </tr>
220
 
        <tr>
221
 
          <td class="paramkey"></td>
222
 
          <td></td>
223
 
          <td class="paramtype">struct SPropValue *&#160;</td>
224
 
          <td class="paramname"><em>spropvalue</em>&#160;</td>
225
 
        </tr>
226
 
        <tr>
227
 
          <td></td>
228
 
          <td>)</td>
229
 
          <td></td><td></td>
230
 
        </tr>
231
 
      </table>
232
 
</div><div class="memdoc">
233
 
<p>Convenience function to convert a PropertyValue_r structure into a SPropValue structure.</p>
234
 
<dl class="params"><dt>Parameters</dt><dd>
235
 
  <table class="params">
236
 
    <tr><td class="paramname">propvalue</td><td>pointer to the PropertyValue_r structure to copy data to </td></tr>
237
 
    <tr><td class="paramname">spropvalue</td><td>pointer to the SPropValue structure to copy data from </td></tr>
238
 
  </table>
239
 
  </dd>
240
 
</dl>
241
 
 
242
 
<p>Referenced by <a class="el" href="property_8c.html#a4ca8f0e75264fec83933df8bcf6e60e1">cast_PropertyRow_to_SRow()</a>.</p>
243
 
 
244
 
</div>
245
 
</div>
246
 
<a class="anchor" id="ac4cc3391330aae4641c05a510b891da9"></a>
247
 
<div class="memitem">
248
 
<div class="memproto">
249
 
      <table class="memname">
250
 
        <tr>
251
 
          <td class="memname">_PUBLIC_ uint32_t cast_SPropValue </td>
252
 
          <td>(</td>
253
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
254
 
          <td class="paramname"><em>mem_ctx</em>, </td>
255
 
        </tr>
256
 
        <tr>
257
 
          <td class="paramkey"></td>
258
 
          <td></td>
259
 
          <td class="paramtype">struct mapi_SPropValue *&#160;</td>
260
 
          <td class="paramname"><em>mapi_sprop</em>, </td>
261
 
        </tr>
262
 
        <tr>
263
 
          <td class="paramkey"></td>
264
 
          <td></td>
265
 
          <td class="paramtype">struct SPropValue *&#160;</td>
266
 
          <td class="paramname"><em>sprop</em>&#160;</td>
267
 
        </tr>
268
 
        <tr>
269
 
          <td></td>
270
 
          <td>)</td>
271
 
          <td></td><td></td>
272
 
        </tr>
273
 
      </table>
274
 
</div><div class="memdoc">
275
 
<p>Convenience function to convert a mapi_SPropValue structure into a SPropValue structure and return the associated size</p>
276
 
<dl class="params"><dt>Parameters</dt><dd>
277
 
  <table class="params">
278
 
    <tr><td class="paramname">mem_ctx</td><td>pointer to the memory context to use for allocation </td></tr>
279
 
    <tr><td class="paramname">mapi_sprop</td><td>pointer to the MAPI SPropValue structure to copy data from </td></tr>
280
 
    <tr><td class="paramname">sprop</td><td>pointer to the SPropValue structure to copy data to</td></tr>
281
 
  </table>
282
 
  </dd>
283
 
</dl>
284
 
<dl class="section return"><dt>Returns</dt><dd>size of the converted data on success, otherwise 0 </dd></dl>
285
 
 
286
 
<p>References <a class="el" href="property_8c.html#a41cb1aa9af66195a07acea1d0f848a3a">get_utf8_utf16_conv_length()</a>.</p>
287
 
 
288
 
</div>
289
 
</div>
290
 
<a class="anchor" id="ac7d9e04c25f0030a7495b21effd3df29"></a>
291
 
<div class="memitem">
292
 
<div class="memproto">
293
 
<table class="mlabels">
294
 
  <tr>
295
 
  <td class="mlabels-left">
296
 
      <table class="memname">
297
 
        <tr>
298
 
          <td class="memname">_PUBLIC_ struct AddressBookEntryId* get_AddressBookEntryId </td>
299
 
          <td>(</td>
300
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
301
 
          <td class="paramname"><em>mem_ctx</em>, </td>
302
 
        </tr>
303
 
        <tr>
304
 
          <td class="paramkey"></td>
305
 
          <td></td>
306
 
          <td class="paramtype">struct Binary_r *&#160;</td>
307
 
          <td class="paramname"><em>bin</em>&#160;</td>
308
 
        </tr>
309
 
        <tr>
310
 
          <td></td>
311
 
          <td>)</td>
312
 
          <td></td><td></td>
313
 
        </tr>
314
 
      </table>
315
 
  </td>
316
 
  <td class="mlabels-right">
317
 
<span class="mlabels"><span class="mlabel">read</span></span>  </td>
318
 
  </tr>
319
 
</table>
320
 
</div><div class="memdoc">
321
 
<p>Retrieve a AddressBookEntryId structure from a binary blob</p>
322
 
<dl class="params"><dt>Parameters</dt><dd>
323
 
  <table class="params">
324
 
    <tr><td class="paramname">mem_ctx</td><td>pointer to the memory context </td></tr>
325
 
    <tr><td class="paramname">bin</td><td>pointer to the Binary_r structure with raw AddressBookEntryId data</td></tr>
326
 
  </table>
327
 
  </dd>
328
 
</dl>
329
 
<dl class="section return"><dt>Returns</dt><dd>Allocated AddressBookEntryId structure on success, otherwise NULL</dd></dl>
330
 
<dl class="section note"><dt>Note</dt><dd>Developers must free the allocated AddressBookEntryId when finished. </dd></dl>
331
 
 
332
 
</div>
333
 
</div>
334
 
<a class="anchor" id="ae12bf1c63d16c4093fe05ce252d9cd27"></a>
335
 
<div class="memitem">
336
 
<div class="memproto">
337
 
<table class="mlabels">
338
 
  <tr>
339
 
  <td class="mlabels-left">
340
 
      <table class="memname">
341
 
        <tr>
342
 
          <td class="memname">_PUBLIC_ struct FolderEntryId* get_FolderEntryId </td>
343
 
          <td>(</td>
344
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
345
 
          <td class="paramname"><em>mem_ctx</em>, </td>
346
 
        </tr>
347
 
        <tr>
348
 
          <td class="paramkey"></td>
349
 
          <td></td>
350
 
          <td class="paramtype">struct Binary_r *&#160;</td>
351
 
          <td class="paramname"><em>bin</em>&#160;</td>
352
 
        </tr>
353
 
        <tr>
354
 
          <td></td>
355
 
          <td>)</td>
356
 
          <td></td><td></td>
357
 
        </tr>
358
 
      </table>
359
 
  </td>
360
 
  <td class="mlabels-right">
361
 
<span class="mlabels"><span class="mlabel">read</span></span>  </td>
362
 
  </tr>
363
 
</table>
364
 
</div><div class="memdoc">
365
 
<p>Retrieve a FolderEntryId structure from a binary blob</p>
366
 
<dl class="params"><dt>Parameters</dt><dd>
367
 
  <table class="params">
368
 
    <tr><td class="paramname">mem_ctx</td><td>pointer to the memory context </td></tr>
369
 
    <tr><td class="paramname">bin</td><td>pointer to the Binary_r structure with raw FolderEntryId data</td></tr>
370
 
  </table>
371
 
  </dd>
372
 
</dl>
373
 
<dl class="section return"><dt>Returns</dt><dd>Allocated FolderEntryId structure on success, otherwise NULL</dd></dl>
374
 
<dl class="section note"><dt>Note</dt><dd>Developers must free the allocated FolderEntryId when finished. </dd></dl>
375
 
 
376
 
</div>
377
 
</div>
378
 
<a class="anchor" id="aae3d014deb6eef2a2ba662321652fb01"></a>
379
 
<div class="memitem">
380
 
<div class="memproto">
381
 
<table class="mlabels">
382
 
  <tr>
383
 
  <td class="mlabels-left">
384
 
      <table class="memname">
385
 
        <tr>
386
 
          <td class="memname">_PUBLIC_ struct GlobalObjectId* get_GlobalObjectId </td>
387
 
          <td>(</td>
388
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
389
 
          <td class="paramname"><em>mem_ctx</em>, </td>
390
 
        </tr>
391
 
        <tr>
392
 
          <td class="paramkey"></td>
393
 
          <td></td>
394
 
          <td class="paramtype">struct Binary_r *&#160;</td>
395
 
          <td class="paramname"><em>bin</em>&#160;</td>
396
 
        </tr>
397
 
        <tr>
398
 
          <td></td>
399
 
          <td>)</td>
400
 
          <td></td><td></td>
401
 
        </tr>
402
 
      </table>
403
 
  </td>
404
 
  <td class="mlabels-right">
405
 
<span class="mlabels"><span class="mlabel">read</span></span>  </td>
406
 
  </tr>
407
 
</table>
408
 
</div><div class="memdoc">
409
 
<p>Retrieve a GlobalObjectId structure from a binary blob</p>
410
 
<dl class="params"><dt>Parameters</dt><dd>
411
 
  <table class="params">
412
 
    <tr><td class="paramname">mem_ctx</td><td>pointer to the memory context </td></tr>
413
 
    <tr><td class="paramname">bin</td><td>pointer to the Binary_r structure with raw GlobalObjectId data</td></tr>
414
 
  </table>
415
 
  </dd>
416
 
</dl>
417
 
<dl class="section return"><dt>Returns</dt><dd>Allocated GlobalObjectId structure on success, otherwise NULL</dd></dl>
418
 
<dl class="section note"><dt>Note</dt><dd>Developers must free the allocated GlobalObjectId when finished. </dd></dl>
419
 
 
420
 
</div>
421
 
</div>
422
 
<a class="anchor" id="ab6d9d832a62f28e9dfa75de0bef677e9"></a>
423
 
<div class="memitem">
424
 
<div class="memproto">
425
 
<table class="mlabels">
426
 
  <tr>
427
 
  <td class="mlabels-left">
428
 
      <table class="memname">
429
 
        <tr>
430
 
          <td class="memname">_PUBLIC_ struct MessageEntryId* get_MessageEntryId </td>
431
 
          <td>(</td>
432
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
433
 
          <td class="paramname"><em>mem_ctx</em>, </td>
434
 
        </tr>
435
 
        <tr>
436
 
          <td class="paramkey"></td>
437
 
          <td></td>
438
 
          <td class="paramtype">struct Binary_r *&#160;</td>
439
 
          <td class="paramname"><em>bin</em>&#160;</td>
440
 
        </tr>
441
 
        <tr>
442
 
          <td></td>
443
 
          <td>)</td>
444
 
          <td></td><td></td>
445
 
        </tr>
446
 
      </table>
447
 
  </td>
448
 
  <td class="mlabels-right">
449
 
<span class="mlabels"><span class="mlabel">read</span></span>  </td>
450
 
  </tr>
451
 
</table>
452
 
</div><div class="memdoc">
453
 
<p>Retrieve a MessageEntryId structure from a binary blob</p>
454
 
<dl class="params"><dt>Parameters</dt><dd>
455
 
  <table class="params">
456
 
    <tr><td class="paramname">mem_ctx</td><td>pointer to the memory context </td></tr>
457
 
    <tr><td class="paramname">bin</td><td>pointer to the Binary_r structure with raw MessageEntryId data</td></tr>
458
 
  </table>
459
 
  </dd>
460
 
</dl>
461
 
<dl class="section return"><dt>Returns</dt><dd>Allocated MessageEntryId structure on success, otherwise NULL</dd></dl>
462
 
<dl class="section note"><dt>Note</dt><dd>Developers must free the allocated MessageEntryId when finished. </dd></dl>
463
 
 
464
 
</div>
465
 
</div>
466
 
<a class="anchor" id="a6f102b15c3af5deec56aeecc22635824"></a>
467
 
<div class="memitem">
468
 
<div class="memproto">
469
 
<table class="mlabels">
470
 
  <tr>
471
 
  <td class="mlabels-left">
472
 
      <table class="memname">
473
 
        <tr>
474
 
          <td class="memname">_PUBLIC_ struct PtypServerId* get_PtypServerId </td>
475
 
          <td>(</td>
476
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
477
 
          <td class="paramname"><em>mem_ctx</em>, </td>
478
 
        </tr>
479
 
        <tr>
480
 
          <td class="paramkey"></td>
481
 
          <td></td>
482
 
          <td class="paramtype">struct Binary_r *&#160;</td>
483
 
          <td class="paramname"><em>bin</em>&#160;</td>
484
 
        </tr>
485
 
        <tr>
486
 
          <td></td>
487
 
          <td>)</td>
488
 
          <td></td><td></td>
489
 
        </tr>
490
 
      </table>
491
 
  </td>
492
 
  <td class="mlabels-right">
493
 
<span class="mlabels"><span class="mlabel">read</span></span>  </td>
494
 
  </tr>
495
 
</table>
496
 
</div><div class="memdoc">
497
 
<p>Retrieve a PtypServerId structure from a binary blob</p>
498
 
<dl class="params"><dt>Parameters</dt><dd>
499
 
  <table class="params">
500
 
    <tr><td class="paramname">mem_ctx</td><td>pointer to the memory context </td></tr>
501
 
    <tr><td class="paramname">bin</td><td>pointer to the Binary_r structure with raw PtypServerId data</td></tr>
502
 
  </table>
503
 
  </dd>
504
 
</dl>
505
 
<dl class="section return"><dt>Returns</dt><dd>Allocated PtypServerId structure on success, otherwise NULL</dd></dl>
506
 
<dl class="section note"><dt>Note</dt><dd>Developers must free the allocated PtypServerId when finished. </dd></dl>
507
 
 
508
 
</div>
509
 
</div>
510
 
<a class="anchor" id="ae3bd3973e59b5a3a17f239176c551463"></a>
511
 
<div class="memitem">
512
 
<div class="memproto">
513
 
<table class="mlabels">
514
 
  <tr>
515
 
  <td class="mlabels-left">
516
 
      <table class="memname">
517
 
        <tr>
518
 
          <td class="memname">_PUBLIC_ struct RecurrencePattern* get_RecurrencePattern </td>
519
 
          <td>(</td>
520
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
521
 
          <td class="paramname"><em>mem_ctx</em>, </td>
522
 
        </tr>
523
 
        <tr>
524
 
          <td class="paramkey"></td>
525
 
          <td></td>
526
 
          <td class="paramtype">struct Binary_r *&#160;</td>
527
 
          <td class="paramname"><em>bin</em>&#160;</td>
528
 
        </tr>
529
 
        <tr>
530
 
          <td></td>
531
 
          <td>)</td>
532
 
          <td></td><td></td>
533
 
        </tr>
534
 
      </table>
535
 
  </td>
536
 
  <td class="mlabels-right">
537
 
<span class="mlabels"><span class="mlabel">read</span></span>  </td>
538
 
  </tr>
539
 
</table>
540
 
</div><div class="memdoc">
541
 
<p>Retrieve a RecurrencePattern structure from a binary blob</p>
542
 
<dl class="params"><dt>Parameters</dt><dd>
543
 
  <table class="params">
544
 
    <tr><td class="paramname">mem_ctx</td><td>pointer to the memory context </td></tr>
545
 
    <tr><td class="paramname">bin</td><td>pointer to the Binary_r structure with non-mapped reccurrence data</td></tr>
546
 
  </table>
547
 
  </dd>
548
 
</dl>
549
 
<dl class="section return"><dt>Returns</dt><dd>Allocated RecurrencePattern structure on success, otherwise NULL</dd></dl>
550
 
<dl class="section note"><dt>Note</dt><dd>Developers must free the allocated RecurrencePattern when finished. </dd></dl>
551
 
 
552
 
</div>
553
 
</div>
554
 
<a class="anchor" id="a8cefc73e7ac8f6a0e972be515b3a1249"></a>
555
 
<div class="memitem">
556
 
<div class="memproto">
557
 
<table class="mlabels">
558
 
  <tr>
559
 
  <td class="mlabels-left">
560
 
      <table class="memname">
561
 
        <tr>
562
 
          <td class="memname">_PUBLIC_ struct TimeZoneStruct* get_TimeZoneStruct </td>
563
 
          <td>(</td>
564
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
565
 
          <td class="paramname"><em>mem_ctx</em>, </td>
566
 
        </tr>
567
 
        <tr>
568
 
          <td class="paramkey"></td>
569
 
          <td></td>
570
 
          <td class="paramtype">struct Binary_r *&#160;</td>
571
 
          <td class="paramname"><em>bin</em>&#160;</td>
572
 
        </tr>
573
 
        <tr>
574
 
          <td></td>
575
 
          <td>)</td>
576
 
          <td></td><td></td>
577
 
        </tr>
578
 
      </table>
579
 
  </td>
580
 
  <td class="mlabels-right">
581
 
<span class="mlabels"><span class="mlabel">read</span></span>  </td>
582
 
  </tr>
583
 
</table>
584
 
</div><div class="memdoc">
585
 
<p>Retrieve a TimeZoneStruct structure from a binary blob</p>
586
 
<dl class="params"><dt>Parameters</dt><dd>
587
 
  <table class="params">
588
 
    <tr><td class="paramname">mem_ctx</td><td>pointer to the memory context </td></tr>
589
 
    <tr><td class="paramname">bin</td><td>pointer to the Binary_r structure with raw TimeZoneStruct data</td></tr>
590
 
  </table>
591
 
  </dd>
592
 
</dl>
593
 
<dl class="section return"><dt>Returns</dt><dd>Allocated TimeZoneStruct structure on success, otherwise NULL</dd></dl>
594
 
<dl class="section note"><dt>Note</dt><dd>Developers must free the allocated TimeZoneStruct when finished. </dd></dl>
595
 
 
596
 
</div>
597
 
</div>
598
 
<a class="anchor" id="a2393ff08f055915dabb95b8b6c13677f"></a>
599
 
<div class="memitem">
600
 
<div class="memproto">
601
 
      <table class="memname">
602
 
        <tr>
603
 
          <td class="memname">_PUBLIC_ const char* get_TypedString </td>
604
 
          <td>(</td>
605
 
          <td class="paramtype">struct TypedString *&#160;</td>
606
 
          <td class="paramname"><em>tstring</em></td><td>)</td>
607
 
          <td></td>
608
 
        </tr>
609
 
      </table>
610
 
</div><div class="memdoc">
611
 
<p>Return the effective value used in a TypedString structure.</p>
612
 
<dl class="params"><dt>Parameters</dt><dd>
613
 
  <table class="params">
614
 
    <tr><td class="paramname">tstring</td><td>pointer to TypedString structure</td></tr>
615
 
  </table>
616
 
  </dd>
617
 
</dl>
618
 
<dl class="section return"><dt>Returns</dt><dd>pointer to a valid string on success, otherwise NULL </dd></dl>
619
 
 
620
 
<p>Referenced by <a class="el" href="IStoreFolder_8c.html#a7b8869cb8d75ee0820b89bda12bea92c">OpenMessage()</a>.</p>
621
 
 
622
 
</div>
623
 
</div>
624
 
<a class="anchor" id="a41cb1aa9af66195a07acea1d0f848a3a"></a>
625
 
<div class="memitem">
626
 
<div class="memproto">
627
 
      <table class="memname">
628
 
        <tr>
629
 
          <td class="memname">size_t get_utf8_utf16_conv_length </td>
630
 
          <td>(</td>
631
 
          <td class="paramtype">const char *&#160;</td>
632
 
          <td class="paramname"><em>inbuf</em></td><td>)</td>
633
 
          <td></td>
634
 
        </tr>
635
 
      </table>
636
 
</div><div class="memdoc">
637
 
<p>Return the expected size of the utf8 string after conversion to utf16 by iconv() function.</p>
638
 
<dl class="params"><dt>Parameters</dt><dd>
639
 
  <table class="params">
640
 
    <tr><td class="paramname">inbuf</td><td>pointer to the input string</td></tr>
641
 
  </table>
642
 
  </dd>
643
 
</dl>
644
 
<dl class="section return"><dt>Returns</dt><dd>expected length of the converted string</dd></dl>
645
 
<dl class="section note"><dt>Note</dt><dd>This routine is based upon utf8_pull() function from samba4/lib/util/charset/iconv.c </dd></dl>
646
 
 
647
 
<p>Referenced by <a class="el" href="property_8c.html#a70f67e9d21b97a881b56f3b44b2dd282">cast_mapi_SPropValue()</a>, <a class="el" href="property_8c.html#ac4cc3391330aae4641c05a510b891da9">cast_SPropValue()</a>, <a class="el" href="IMAPIFolder_8c.html#adda493203e99475273c498c1f051bfd4">CopyFolder()</a>, <a class="el" href="IMAPIFolder_8c.html#a03a3f5d51af0ce6d0a92a5d319326f93">CreateFolder()</a>, <a class="el" href="IMAPIProp_8c.html#ac7a673fa38d4f737c5b1f8fa905f8155">GetIDsFromNames()</a>, <a class="el" href="mapi__nameid_8c.html#acdd818c4090d6ea172953f5a97a033f4">mapi_nameid_canonical_add()</a>, <a class="el" href="mapi__nameid_8c.html#a34710e905d2bcf098de2365415453c38">mapi_nameid_custom_string_add()</a>, <a class="el" href="mapi__nameid_8c.html#a3410b119334bc8fb8e8019f0127dd5fc">mapi_nameid_lid_add()</a>, <a class="el" href="mapi__nameid_8c.html#aa96315dd49d7670a915e2089a71fa28e">mapi_nameid_OOM_add()</a>, <a class="el" href="mapi__nameid_8c.html#a5ad1d6a8274cef96436cfec5b5d5e102">mapi_nameid_string_add()</a>, <a class="el" href="IMessage_8c.html#a2631355714b42d3d972113372c5175e0">ModifyRecipients()</a>, and <a class="el" href="IMAPIFolder_8c.html#a81405ca3fef5b65fae9d1cb33d315e08">MoveFolder()</a>.</p>
648
 
 
649
 
</div>
650
 
</div>
651
 
<a class="anchor" id="aa640ff2bdce68e12dd579981a94487f7"></a>
652
 
<div class="memitem">
653
 
<div class="memproto">
654
 
      <table class="memname">
655
 
        <tr>
656
 
          <td class="memname">_PUBLIC_ void mapi_copy_spropvalues </td>
657
 
          <td>(</td>
658
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
659
 
          <td class="paramname"><em>mem_ctx</em>, </td>
660
 
        </tr>
661
 
        <tr>
662
 
          <td class="paramkey"></td>
663
 
          <td></td>
664
 
          <td class="paramtype">struct SPropValue *&#160;</td>
665
 
          <td class="paramname"><em>source_values</em>, </td>
666
 
        </tr>
667
 
        <tr>
668
 
          <td class="paramkey"></td>
669
 
          <td></td>
670
 
          <td class="paramtype">struct SPropValue *&#160;</td>
671
 
          <td class="paramname"><em>dest_values</em>, </td>
672
 
        </tr>
673
 
        <tr>
674
 
          <td class="paramkey"></td>
675
 
          <td></td>
676
 
          <td class="paramtype">uint32_t&#160;</td>
677
 
          <td class="paramname"><em>count</em>&#160;</td>
678
 
        </tr>
679
 
        <tr>
680
 
          <td></td>
681
 
          <td>)</td>
682
 
          <td></td><td></td>
683
 
        </tr>
684
 
      </table>
685
 
</div><div class="memdoc">
686
 
<p>Convenience function to copy an array of struct SPropValue or a part thereof into another array, by duplicating and properly parenting pointer data. The destination array is considered to be preallocated. </p>
687
 
 
688
 
</div>
689
 
</div>
690
 
<a class="anchor" id="ac9c73f628a128cc4c4fa1d92f53e1d05"></a>
691
 
<div class="memitem">
692
 
<div class="memproto">
693
 
      <table class="memname">
694
 
        <tr>
695
 
          <td class="memname">_PUBLIC_ enum MAPISTATUS PropertyRow_addprop </td>
696
 
          <td>(</td>
697
 
          <td class="paramtype">struct PropertyRow_r *&#160;</td>
698
 
          <td class="paramname"><em>aRow</em>, </td>
699
 
        </tr>
700
 
        <tr>
701
 
          <td class="paramkey"></td>
702
 
          <td></td>
703
 
          <td class="paramtype">struct PropertyValue_r&#160;</td>
704
 
          <td class="paramname"><em>propValue</em>&#160;</td>
705
 
        </tr>
706
 
        <tr>
707
 
          <td></td>
708
 
          <td>)</td>
709
 
          <td></td><td></td>
710
 
        </tr>
711
 
      </table>
712
 
</div><div class="memdoc">
713
 
<p>add a PropertyValue_r structure to a PropertyRow_r array</p>
714
 
<dl class="params"><dt>Parameters</dt><dd>
715
 
  <table class="params">
716
 
    <tr><td class="paramname">aRow</td><td>pointer to the PropertyRow_r array where propValue should be appended </td></tr>
717
 
    <tr><td class="paramname">propValue</td><td>the PropertyValue_r structure to add to aRow</td></tr>
718
 
  </table>
719
 
  </dd>
720
 
</dl>
721
 
<dl class="section return"><dt>Returns</dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI_E_INVALID_PARAMETER. </dd></dl>
722
 
 
723
 
</div>
724
 
</div>
725
 
<a class="anchor" id="a16e519b5740026cdc4ba61a867445db3"></a>
726
 
<div class="memitem">
727
 
<div class="memproto">
728
 
      <table class="memname">
729
 
        <tr>
730
 
          <td class="memname">_PUBLIC_ uint32_t PropertyRowSet_propcpy </td>
731
 
          <td>(</td>
732
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
733
 
          <td class="paramname"><em>mem_ctx</em>, </td>
734
 
        </tr>
735
 
        <tr>
736
 
          <td class="paramkey"></td>
737
 
          <td></td>
738
 
          <td class="paramtype">struct PropertyRowSet_r *&#160;</td>
739
 
          <td class="paramname"><em>RowSet</em>, </td>
740
 
        </tr>
741
 
        <tr>
742
 
          <td class="paramkey"></td>
743
 
          <td></td>
744
 
          <td class="paramtype">struct PropertyValue_r&#160;</td>
745
 
          <td class="paramname"><em>value</em>&#160;</td>
746
 
        </tr>
747
 
        <tr>
748
 
          <td></td>
749
 
          <td>)</td>
750
 
          <td></td><td></td>
751
 
        </tr>
752
 
      </table>
753
 
</div><div class="memdoc">
754
 
<p>Append a PropertyValue_r structure to given PropertyRowSet_r</p>
755
 
<dl class="params"><dt>Parameters</dt><dd>
756
 
  <table class="params">
757
 
    <tr><td class="paramname">mem_ctx</td><td>pointer to the memory context </td></tr>
758
 
    <tr><td class="paramname">RowSet</td><td>pointer to the PropertyRowSet_r array to update </td></tr>
759
 
    <tr><td class="paramname">value</td><td>the PropertyValue_r to append within SRowSet</td></tr>
760
 
  </table>
761
 
  </dd>
762
 
</dl>
763
 
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise 1 </dd></dl>
764
 
 
765
 
</div>
766
 
</div>
767
 
<a class="anchor" id="a08d81a8e5a6ec970d5ff891e325de402"></a>
768
 
<div class="memitem">
769
 
<div class="memproto">
770
 
<table class="mlabels">
771
 
  <tr>
772
 
  <td class="mlabels-left">
773
 
      <table class="memname">
774
 
        <tr>
775
 
          <td class="memname">_PUBLIC_ struct SPropTagArray* set_SPropTagArray </td>
776
 
          <td>(</td>
777
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
778
 
          <td class="paramname"><em>mem_ctx</em>, </td>
779
 
        </tr>
780
 
        <tr>
781
 
          <td class="paramkey"></td>
782
 
          <td></td>
783
 
          <td class="paramtype">uint32_t&#160;</td>
784
 
          <td class="paramname"><em>PropCount</em>, </td>
785
 
        </tr>
786
 
        <tr>
787
 
          <td class="paramkey"></td>
788
 
          <td></td>
789
 
          <td class="paramtype">&#160;</td>
790
 
          <td class="paramname"><em>...</em>&#160;</td>
791
 
        </tr>
792
 
        <tr>
793
 
          <td></td>
794
 
          <td>)</td>
795
 
          <td></td><td></td>
796
 
        </tr>
797
 
      </table>
798
 
  </td>
799
 
  <td class="mlabels-right">
800
 
<span class="mlabels"><span class="mlabel">read</span></span>  </td>
801
 
  </tr>
802
 
</table>
803
 
</div><div class="memdoc">
804
 
<p>Create a property tag array</p>
805
 
<dl class="params"><dt>Parameters</dt><dd>
806
 
  <table class="params">
807
 
    <tr><td class="paramname">mem_ctx</td><td>talloc memory context to use for allocation </td></tr>
808
 
    <tr><td class="paramname">PropCount</td><td>the number of properties in the array</td></tr>
809
 
  </table>
810
 
  </dd>
811
 
</dl>
812
 
<p>The varargs (the third and subsequent arguments) are the property tags to make up the array. So the normal way to use this to create an array of two tags is like: </p>
813
 
<div class="fragment"><div class="line"><span class="keyword">struct </span>SPropTagArray *array</div>
814
 
<div class="line">array = <a class="code" href="property_8c.html#a08d81a8e5a6ec970d5ff891e325de402">set_SPropTagArray</a>(mem_ctx, 2, PR_ENTRYID, PR_DISPLAY_NAME);</div>
815
 
</div><!-- fragment --> <dl><dt><b>Examples: </b></dt><dd><a class="el" href="fetchappointment_8c-example.html#a8">fetchappointment.c</a>, and <a class="el" href="fetchmail_8c-example.html#a8">fetchmail.c</a>.</dd>
816
 
</dl>
817
 
<p>Referenced by <a class="el" href="simple__mapi_8c.html#a2445fb102be62563bdd8d24025f3be2b">AddUserPermission()</a>, <a class="el" href="IProfAdmin_8c.html#a104894cedb71ce6f4485726605d6fc71">DuplicateProfile()</a>, <a class="el" href="utils_8c.html#a01d9de5c2de79ccdc0aa9a8a482e8a32">EntryIDFromSourceIDForMessage()</a>, <a class="el" href="IABContainer_8c.html#abd45ada24b1a37bec53a2f521c69fb4c">GetABRecipientInfo()</a>, <a class="el" href="simple__mapi_8c.html#ac77ec981ccaa328f0fd1c9cdc03ae153">GetBestBody()</a>, <a class="el" href="simple__mapi_8c.html#a7b3fc634875a5d59ea50a4b8f0b11074">GetFolderItemsCount()</a>, <a class="el" href="freebusy_8c.html#ab96741fc9618726a6eedc08c8813671e">GetUserFreeBusyData()</a>, <a class="el" href="simple__mapi_8c.html#a9cb54788ad5b18ab5e714405a043b049">ModifyUserPermission()</a>, <a class="el" href="IProfAdmin_8c.html#a714fa290608519268427cfda413bb86a">ProcessNetworkProfile()</a>, and <a class="el" href="simple__mapi_8c.html#a6b974921b0a3421b48933e564230d664">RemoveUserPermission()</a>.</p>
818
 
 
819
 
</div>
820
 
</div>
821
 
<a class="anchor" id="a1a74a2f9bad1de37fa07ff51707473a1"></a>
822
 
<div class="memitem">
823
 
<div class="memproto">
824
 
      <table class="memname">
825
 
        <tr>
826
 
          <td class="memname">_PUBLIC_ enum MAPISTATUS SPropTagArray_add </td>
827
 
          <td>(</td>
828
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
829
 
          <td class="paramname"><em>mem_ctx</em>, </td>
830
 
        </tr>
831
 
        <tr>
832
 
          <td class="paramkey"></td>
833
 
          <td></td>
834
 
          <td class="paramtype">struct SPropTagArray *&#160;</td>
835
 
          <td class="paramname"><em>SPropTagArray</em>, </td>
836
 
        </tr>
837
 
        <tr>
838
 
          <td class="paramkey"></td>
839
 
          <td></td>
840
 
          <td class="paramtype">enum MAPITAGS&#160;</td>
841
 
          <td class="paramname"><em>aulPropTag</em>&#160;</td>
842
 
        </tr>
843
 
        <tr>
844
 
          <td></td>
845
 
          <td>)</td>
846
 
          <td></td><td></td>
847
 
        </tr>
848
 
      </table>
849
 
</div><div class="memdoc">
850
 
<p>Add a property tag to an existing properties array</p>
851
 
<dl class="params"><dt>Parameters</dt><dd>
852
 
  <table class="params">
853
 
    <tr><td class="paramname">mem_ctx</td><td>talloc memory context to use for allocation </td></tr>
854
 
    <tr><td class="paramname">SPropTagArray</td><td>existing properties array to add to </td></tr>
855
 
    <tr><td class="paramname">aulPropTag</td><td>the property tag to add</td></tr>
856
 
  </table>
857
 
  </dd>
858
 
</dl>
859
 
<dl class="section return"><dt>Returns</dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl>
860
 
<dl class="section note"><dt>Note</dt><dd>Possible MAPI error codes are:<ul>
861
 
<li>MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized</li>
862
 
<li>MAPI_E_INVALID_PARAMETER: SPropTagArray parameter is not correctly set </li>
863
 
</ul>
864
 
</dd></dl>
865
 
 
866
 
<p>Referenced by <a class="el" href="IMessage_8c.html#a8502b9418d37081aeeb0a45650517cc2">OpenEmbeddedMessage()</a>, <a class="el" href="IStoreFolder_8c.html#a7b8869cb8d75ee0820b89bda12bea92c">OpenMessage()</a>, and <a class="el" href="IStoreFolder_8c.html#adbe909381fb7d192772e2e3f6f164976">ReloadCachedInformation()</a>.</p>
867
 
 
868
 
</div>
869
 
</div>
870
 
<a class="anchor" id="a67e3ce67f22d6803a33b1ae1ad794c8c"></a>
871
 
<div class="memitem">
872
 
<div class="memproto">
873
 
      <table class="memname">
874
 
        <tr>
875
 
          <td class="memname">_PUBLIC_ enum MAPISTATUS SPropTagArray_delete </td>
876
 
          <td>(</td>
877
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
878
 
          <td class="paramname"><em>mem_ctx</em>, </td>
879
 
        </tr>
880
 
        <tr>
881
 
          <td class="paramkey"></td>
882
 
          <td></td>
883
 
          <td class="paramtype">struct SPropTagArray *&#160;</td>
884
 
          <td class="paramname"><em>SPropTagArray</em>, </td>
885
 
        </tr>
886
 
        <tr>
887
 
          <td class="paramkey"></td>
888
 
          <td></td>
889
 
          <td class="paramtype">uint32_t&#160;</td>
890
 
          <td class="paramname"><em>aulPropTag</em>&#160;</td>
891
 
        </tr>
892
 
        <tr>
893
 
          <td></td>
894
 
          <td>)</td>
895
 
          <td></td><td></td>
896
 
        </tr>
897
 
      </table>
898
 
</div><div class="memdoc">
899
 
<p>Delete a property tag from an existing properties array</p>
900
 
<dl class="params"><dt>Parameters</dt><dd>
901
 
  <table class="params">
902
 
    <tr><td class="paramname">mem_ctx</td><td>talloc memory context to use for allocation </td></tr>
903
 
    <tr><td class="paramname">SPropTagArray</td><td>existing properties array to remove from </td></tr>
904
 
    <tr><td class="paramname">aulPropTag</td><td>the property tag to remove</td></tr>
905
 
  </table>
906
 
  </dd>
907
 
</dl>
908
 
<dl class="section return"><dt>Returns</dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl>
909
 
<dl class="section note"><dt>Note</dt><dd>Possible MAPI error codes are:<ul>
910
 
<li>MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized</li>
911
 
<li>MAPI_E_INVALID_PARAMETER: SPropTagArray parameter is not correctly set </li>
912
 
</ul>
913
 
</dd></dl>
914
 
 
915
 
</div>
916
 
</div>
917
 
<a class="anchor" id="aa7d5460810482491c5829c4b6be2fe8f"></a>
918
 
<div class="memitem">
919
 
<div class="memproto">
920
 
      <table class="memname">
921
 
        <tr>
922
 
          <td class="memname">_PUBLIC_ enum MAPISTATUS SPropTagArray_find </td>
923
 
          <td>(</td>
924
 
          <td class="paramtype">struct SPropTagArray SPropTagArray&#160;</td>
925
 
          <td class="paramname">, </td>
926
 
        </tr>
927
 
        <tr>
928
 
          <td class="paramkey"></td>
929
 
          <td></td>
930
 
          <td class="paramtype">enum MAPITAGS&#160;</td>
931
 
          <td class="paramname"><em>aulPropTag</em>, </td>
932
 
        </tr>
933
 
        <tr>
934
 
          <td class="paramkey"></td>
935
 
          <td></td>
936
 
          <td class="paramtype">uint32_t *&#160;</td>
937
 
          <td class="paramname"><em>propIdx</em>&#160;</td>
938
 
        </tr>
939
 
        <tr>
940
 
          <td></td>
941
 
          <td>)</td>
942
 
          <td></td><td></td>
943
 
        </tr>
944
 
      </table>
945
 
</div><div class="memdoc">
946
 
<p>Return the index of a property tag in an existing properties array</p>
947
 
<dl class="params"><dt>Parameters</dt><dd>
948
 
  <table class="params">
949
 
    <tr><td class="paramname">SPropTagArray</td><td>existing properties array to remove from </td></tr>
950
 
    <tr><td class="paramname">aulPropTag</td><td>the property tag to find </td></tr>
951
 
    <tr><td class="paramname">propIdx</td><td>the index of the found property (undefined when MAPI_E_NOT_FOUND is returned)</td></tr>
952
 
  </table>
953
 
  </dd>
954
 
</dl>
955
 
<dl class="section return"><dt>Returns</dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl>
956
 
<dl class="section note"><dt>Note</dt><dd>Possible MAPI error codes are:<ul>
957
 
<li>MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized</li>
958
 
<li>MAPI_E_INVALID_PARAMETER: SPropTagArray parameter is not correctly set </li>
959
 
</ul>
960
 
</dd></dl>
961
 
 
962
 
</div>
963
 
</div>
964
 
<a class="anchor" id="a4aeef6cda2c452388ab2b2865efa6627"></a>
965
 
<div class="memitem">
966
 
<div class="memproto">
967
 
      <table class="memname">
968
 
        <tr>
969
 
          <td class="memname">_PUBLIC_ enum MAPISTATUS SRow_addprop </td>
970
 
          <td>(</td>
971
 
          <td class="paramtype">struct SRow *&#160;</td>
972
 
          <td class="paramname"><em>aRow</em>, </td>
973
 
        </tr>
974
 
        <tr>
975
 
          <td class="paramkey"></td>
976
 
          <td></td>
977
 
          <td class="paramtype">struct SPropValue&#160;</td>
978
 
          <td class="paramname"><em>spropvalue</em>&#160;</td>
979
 
        </tr>
980
 
        <tr>
981
 
          <td></td>
982
 
          <td>)</td>
983
 
          <td></td><td></td>
984
 
        </tr>
985
 
      </table>
986
 
</div><div class="memdoc">
987
 
<p>add a SPropValue structure to a SRow array</p>
988
 
<dl class="params"><dt>Parameters</dt><dd>
989
 
  <table class="params">
990
 
    <tr><td class="paramname">aRow</td><td>pointer to the SRow array where spropvalue should be appended </td></tr>
991
 
    <tr><td class="paramname">spropvalue</td><td>reference to the SPropValue structure to add to aRow</td></tr>
992
 
  </table>
993
 
  </dd>
994
 
</dl>
995
 
<dl class="section return"><dt>Returns</dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI_E_INVALID_PARAMETER. </dd></dl>
996
 
 
997
 
<p>Referenced by <a class="el" href="IMessage_8c.html#a8502b9418d37081aeeb0a45650517cc2">OpenEmbeddedMessage()</a>, <a class="el" href="IStoreFolder_8c.html#a7b8869cb8d75ee0820b89bda12bea92c">OpenMessage()</a>, <a class="el" href="IStoreFolder_8c.html#adbe909381fb7d192772e2e3f6f164976">ReloadCachedInformation()</a>, and <a class="el" href="IMessage_8c.html#a4f9d320848d212246eb39cede17c7f2e">SetRecipientType()</a>.</p>
998
 
 
999
 
</div>
1000
 
</div>
1001
 
<a class="anchor" id="a786b1f3480dfa430b3e361d4de4770e2"></a>
1002
 
<div class="memitem">
1003
 
<div class="memproto">
1004
 
      <table class="memname">
1005
 
        <tr>
1006
 
          <td class="memname">_PUBLIC_ uint32_t SRowSet_propcpy </td>
1007
 
          <td>(</td>
1008
 
          <td class="paramtype">TALLOC_CTX *&#160;</td>
1009
 
          <td class="paramname"><em>mem_ctx</em>, </td>
1010
 
        </tr>
1011
 
        <tr>
1012
 
          <td class="paramkey"></td>
1013
 
          <td></td>
1014
 
          <td class="paramtype">struct SRowSet *&#160;</td>
1015
 
          <td class="paramname"><em>SRowSet</em>, </td>
1016
 
        </tr>
1017
 
        <tr>
1018
 
          <td class="paramkey"></td>
1019
 
          <td></td>
1020
 
          <td class="paramtype">struct SPropValue&#160;</td>
1021
 
          <td class="paramname"><em>spropvalue</em>&#160;</td>
1022
 
        </tr>
1023
 
        <tr>
1024
 
          <td></td>
1025
 
          <td>)</td>
1026
 
          <td></td><td></td>
1027
 
        </tr>
1028
 
      </table>
1029
 
</div><div class="memdoc">
1030
 
<p>Append a SPropValue structure to given SRowSet</p>
1031
 
<dl class="params"><dt>Parameters</dt><dd>
1032
 
  <table class="params">
1033
 
    <tr><td class="paramname">mem_ctx</td><td>pointer to the memory context </td></tr>
1034
 
    <tr><td class="paramname">SRowSet</td><td>pointer to the SRowSet array to update </td></tr>
1035
 
    <tr><td class="paramname">spropvalue</td><td>the SPropValue to append within SRowSet</td></tr>
1036
 
  </table>
1037
 
  </dd>
1038
 
</dl>
1039
 
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise 1 </dd></dl>
1040
 
 
1041
 
</div>
1042
 
</div>
1043
 
</div><!-- contents -->
1044
 
</div>
1045
 
<br/>
1046
 
<table style="clear:both; margin: 0.5em auto; width:80%; text-align: center; background-color:#f8f8f8; border:2px solid #e0e0e0; padding:5px;">
1047
 
<tr>
1048
 
<td> 
1049
 
  <img alt="Creative Commons License" src="CC_SomeRightsReserved.png" width="90" height="30" border="0" /><br />
1050
 
  <img alt="Creative Commons Attribution icon" src="24px-Cc-by_white.svg.png" width="24" height="24" border="0" />
1051
 
  <img alt="Creative Commons Share Alike icon" src="24px-Cc-sa_white.svg.png" width="24" height="24" border="0" />
1052
 
</td>
1053
 
<td> <i><strong class="selflink">This content</strong> is licensed under the Creative Commons<br />
1054
 
Attribution ShareAlike License v. 3.0:<br />
1055
 
<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>
1056
 
</td></tr></table>
1057
 
<br/>
1058
 
</div>
1059
 
</div>
1060
 
</body>
1061
 
</html>