<html>
<head>
<title>MAPIClientLibraries 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><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="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>libmapi/freebusy.c File Reference</h1> </div>
</div>
<div class="contents">
<p>Convenient API to access FreeBusy.
<a href="#_details">More...</a></p>
<code>#include <<a class="el" href="libmapi_8h.html">libmapi/libmapi.h</a>></code><br/>
<code>#include <ctype.h></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="freebusy_8c.html#a55256ae8659126e7dad1d67359697be2">GetFreeBusyYear</a> (const uint32_t *publish_start)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="freebusy_8c.html#ab96741fc9618726a6eedc08c8813671e">GetUserFreeBusyData</a> (<a class="el" href="structmapi__object.html">mapi_object_t</a> *obj_store, const char *recipient, struct SRow *pSRow)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="freebusy_8c.html#a657c4fc0821a80c8efd44a3ac760dfeb">IsFreeBusyConflict</a> (<a class="el" href="structmapi__object.html">mapi_object_t</a> *obj_store, struct FILETIME *date, bool *conflict)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Convenient API to access FreeBusy. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a55256ae8659126e7dad1d67359697be2"></a><!-- doxytag: member="freebusy.c::GetFreeBusyYear" ref="a55256ae8659126e7dad1d67359697be2" args="(const uint32_t *publish_start)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ int GetFreeBusyYear </td>
<td>(</td>
<td class="paramtype">const uint32_t * </td>
<td class="paramname"> <em>publish_start</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the year associated with the FreeBusy start range</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>publish_start</em> </td><td>pointer to the publish start integer</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a valid year on success, otherwise 0 </dd></dl>
<p>Referenced by <a class="el" href="proto_8h.html#ab76911cad62468f2d40c277e63e4b548">IsFreeBusyConflict()</a>.</p>
</div>
</div>
<a class="anchor" id="ab96741fc9618726a6eedc08c8813671e"></a><!-- doxytag: member="freebusy.c::GetUserFreeBusyData" ref="ab96741fc9618726a6eedc08c8813671e" args="(mapi_object_t *obj_store, const char *recipient, struct SRow *pSRow)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS GetUserFreeBusyData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmapi__object.html">mapi_object_t</a> * </td>
<td class="paramname"> <em>obj_store</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>recipient</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct SRow * </td>
<td class="paramname"> <em>pSRow</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve FreeBusy data associated with the specified recipient</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>pointer to the public folder MAPI object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>recipient</em> </td><td>name of the recipient to fetch freebusy data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pSRow</em> </td><td>pointer to the returned properties</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The function returns a SRow structure with the following property tags:<ol type="1">
<li>PR_NORMALIZED_SUBJECT</li>
<li>PR_FREEBUSY_LAST_MODIFIED</li>
<li>PR_FREEBUSY_START_RANGE</li>
<li>PR_FREEBUSY_END_RANGE</li>
<li>PR_FREEBUSY_ALL_MONTHS</li>
<li>PR_FREEBUSY_ALL_EVENTS</li>
<li>PR_FREEBUSY_TENTATIVE_MONTHS</li>
<li>PR_FREEBUSY_TENTATIVE_EVENTS</li>
<li>PR_FREEBUSY_BUSY_MONTHS</li>
<li>PR_FREEBUSY_BUSY_EVENTS</li>
<li>PR_FREEBUSY_OOF_MONTHS</li>
<li>PR_FREEBUSY_OOF_EVENTS</li>
</ol>
</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error </dd></dl>
<p>References <a class="el" href="IMAPITable_8c.html#a9e423d011e898e328c6a510104a37565">FindRow()</a>, <a class="el" href="mapidefs_8h.html#a7a4567468a4c8b49581cb6208b13eb91">FREEBUSY_FOLDER</a>, <a class="el" href="mapidefs_8h.html#affdc102e9e240cf4fddf3e3e1c5b4133">FREEBUSY_USER</a>, <a class="el" href="property_8c.html#ab9674052880bd788820b7748cef584e5">get_SPropValue_SRowSet_data()</a>, <a class="el" href="IABContainer_8c.html#ad936e550d73780a978a726d9ce213562">GetABRecipientInfo()</a>, <a class="el" href="IMAPIContainer_8c.html#a45f243bea0975066cc0112c57951e8a2">GetContentsTable()</a>, <a class="el" href="proto_8h.html#abb7b807765b5282cccc87202bf1b3639">GetDefaultPublicFolder()</a>, <a class="el" href="IMAPIContainer_8c.html#aabf483e456de9d3621464537e9367445">GetHierarchyTable()</a>, <a class="el" href="IMAPIProp_8c.html#ad71fddaae9ab98871ffe4fec3938a704">GetProps()</a>, <a class="el" href="cdo__mapi_8c.html#aa3c2b68912988f290961037c76478495">global_mapi_ctx</a>, <a class="el" href="mapi__object_8c.html#ae5ef3137838fbc0c3eaedd7da99f8adc">mapi_object_get_session()</a>, <a class="el" href="mapi__object_8c.html#af49c3130b8cb47f741ff652fc53c1364">mapi_object_init()</a>, <a class="el" href="mapi__object_8c.html#ade2b4701fae8a110c476b894834831b9">mapi_object_release()</a>, <a class="el" href="IUnknown_8c.html#a52246b3bbc755db550d9d13e772dd479">MAPIFreeBuffer()</a>, <a class="el" href="mapidefs_8h.html#af83bb47d4df6732781e20dce27ae543b">olFolderPublicFreeBusyRoot</a>, <a class="el" href="mapicode_8h.html#a72f77c7e5d097e7b47c57c0405070d0c">OPENCHANGE_RETVAL_IF</a>, <a class="el" href="IMsgStore_8c.html#a8b90a95da815aaed2c2728c2599007c1">OpenFolder()</a>, <a class="el" href="IStoreFolder_8c.html#a7b8869cb8d75ee0820b89bda12bea92c">OpenMessage()</a>, <a class="el" href="nspi_8h.html#aee2888368c5f2ab01e1716052e7afbaf">ORG</a>, <a class="el" href="nspi_8h.html#a4915d7ba51da88284428b118cbeda19f">ORG_UNIT</a>, <a class="el" href="mapitags_8h.html#ad081c2c191cb480a24448262dc2e2f89">PR_ADDRBOOK_MID</a>, <a class="el" href="mapitags_8h.html#a449ee8cc69f5b054e2bc95f64d58322f">PR_DISPLAY_NAME</a>, <a class="el" href="mapitags_8h.html#a781db3191ae7007b8158d305b80ee2af">PR_EMAIL_ADDRESS_UNICODE</a>, <a class="el" href="mapitags_8h.html#a5b2ce4183a39afc8c9855b34dd62ca1c">PR_FID</a>, <a class="el" href="mapitags_8h.html#aeddd2134a3e8729cddbdca2fc6530519">PR_FREEBUSY_ALL_EVENTS</a>, <a class="el" href="mapitags_8h.html#a31aa983dd4e46ef1051655252d056434">PR_FREEBUSY_ALL_MONTHS</a>, <a class="el" href="mapitags_8h.html#a4cadf20d8d365c52862e14c07c2fe91f">PR_FREEBUSY_BUSY_EVENTS</a>, <a class="el" href="mapitags_8h.html#a83b5b527d9184556f45944e51ccdcd1c">PR_FREEBUSY_BUSY_MONTHS</a>, <a class="el" href="mapitags_8h.html#a5d908f1fd1a3ef855cea3fe620957cef">PR_FREEBUSY_END_RANGE</a>, <a class="el" href="mapitags_8h.html#a052505cad822e37e67544a766b8334e0">PR_FREEBUSY_LAST_MODIFIED</a>, <a class="el" href="mapitags_8h.html#afb91ab1c758aad3b5902150bbbe72803">PR_FREEBUSY_OOF_EVENTS</a>, <a class="el" href="mapitags_8h.html#a34994d8f931066d238e5acd03d18d81a">PR_FREEBUSY_OOF_MONTHS</a>, <a class="el" href="mapitags_8h.html#a7b48b67d6236e291dac3ecf2c60513f5">PR_FREEBUSY_START_RANGE</a>, <a class="el" href="mapitags_8h.html#aaa6fc8a5628bfeeab095b02d590f9941">PR_FREEBUSY_TENTATIVE_EVENTS</a>, <a class="el" href="mapitags_8h.html#a1c156344bd5380a059f50b133353377f">PR_FREEBUSY_TENTATIVE_MONTHS</a>, <a class="el" href="mapitags_8h.html#a838d8bbbbf674f002a79b29eac635ca6">PR_INSTANCE_NUM</a>, <a class="el" href="mapitags_8h.html#ab3b955ff9e0f8dff5a841b3ee5955b51">PR_MID</a>, <a class="el" href="mapitags_8h.html#a3cc8328453e97d26be7439d1a8768ef2">PR_NORMALIZED_SUBJECT</a>, <a class="el" href="property_8c.html#a08d81a8e5a6ec970d5ff891e325de402">set_SPropTagArray()</a>, <a class="el" href="IMAPITable_8c.html#a266cd7f791acf5d9721f5e9e8ac5d49f">SetColumns()</a>, <a class="el" href="IMAPITable_8c.html#a62966b2e1623c625019195ebcc3d5359">SortTable()</a>, and <a class="el" href="proto_8h.html#add6b6308d8c7071db82453322c46df27">x500_get_dn_element()</a>.</p>
<p>Referenced by <a class="el" href="proto_8h.html#ab76911cad62468f2d40c277e63e4b548">IsFreeBusyConflict()</a>.</p>
</div>
</div>
<a class="anchor" id="a657c4fc0821a80c8efd44a3ac760dfeb"></a><!-- doxytag: member="freebusy.c::IsFreeBusyConflict" ref="a657c4fc0821a80c8efd44a3ac760dfeb" args="(mapi_object_t *obj_store, struct FILETIME *date, bool *conflict)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS IsFreeBusyConflict </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmapi__object.html">mapi_object_t</a> * </td>
<td class="paramname"> <em>obj_store</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct FILETIME * </td>
<td class="paramname"> <em>date</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool * </td>
<td class="paramname"> <em>conflict</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if a date conflicts with existing FreeBusy Busy/Out Of Office events</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>pointer to the public folder MAPI object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>date</em> </td><td>pointer to the date to check </td></tr>
<tr><td valign="top"></td><td valign="top"><em>conflict</em> </td><td>pointer to the returned boolean value</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error </dd></dl>
<p>References <a class="el" href="property_8c.html#a9b7f82ab0f8700a6ca1b1baf0a1d2d07">find_SPropValue_data()</a>, <a class="el" href="freebusy_8c.html#a55256ae8659126e7dad1d67359697be2">GetFreeBusyYear()</a>, <a class="el" href="freebusy_8c.html#ab96741fc9618726a6eedc08c8813671e">GetUserFreeBusyData()</a>, <a class="el" href="cdo__mapi_8c.html#aa3c2b68912988f290961037c76478495">global_mapi_ctx</a>, <a class="el" href="mapi__object_8c.html#ae5ef3137838fbc0c3eaedd7da99f8adc">mapi_object_get_session()</a>, <a class="el" href="mapicode_8h.html#a72f77c7e5d097e7b47c57c0405070d0c">OPENCHANGE_RETVAL_IF</a>, <a class="el" href="mapitags_8h.html#aeddd2134a3e8729cddbdca2fc6530519">PR_FREEBUSY_ALL_EVENTS</a>, <a class="el" href="mapitags_8h.html#a31aa983dd4e46ef1051655252d056434">PR_FREEBUSY_ALL_MONTHS</a>, <a class="el" href="mapitags_8h.html#a7b48b67d6236e291dac3ecf2c60513f5">PR_FREEBUSY_START_RANGE</a>, <a class="el" href="structmapi__session.html#aaf43b41f2628347b7944827c49334a5a">mapi_session::profile</a>, and <a class="el" href="structmapi__profile.html#aa59e563eab407a53f80ac3841650bfc2">mapi_profile::username</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>
