<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/freebusy.c File Reference</h1>Convenient API to access FreeBusy.
<a href="#_details">More...</a>
<p>
<code>#include <libmapi/libmapi.h></code><br>
<code>#include <ctype.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_ int </td><td class="memItemRight" valign="bottom"><a class="el" href="freebusy_8c.html#55256ae8659126e7dad1d67359697be2">GetFreeBusyYear</a> (const uint32_t *publish_start)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="freebusy_8c.html#b96741fc9618726a6eedc08c8813671e">GetUserFreeBusyData</a> (mapi_object_t *obj_store, const char *recipient, struct SRow *pSRow)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="freebusy_8c.html#657c4fc0821a80c8efd44a3ac760dfeb">IsFreeBusyConflict</a> (mapi_object_t *obj_store, struct FILETIME *date, bool *conflict)</td></tr>
</table>
<hr><h2>Detailed Description</h2>
Convenient API to access FreeBusy.
<p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="55256ae8659126e7dad1d67359697be2"></a><!-- doxytag: member="freebusy.c::GetFreeBusyYear" ref="55256ae8659126e7dad1d67359697be2" 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 compact><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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a valid year on success, otherwise 0 </dd></dl>
<p>Referenced by <a class="el" href="freebusy_8c_source.html#l00247">IsFreeBusyConflict()</a>.</p>
</div>
</div><p>
<a class="anchor" name="b96741fc9618726a6eedc08c8813671e"></a><!-- doxytag: member="freebusy.c::GetUserFreeBusyData" ref="b96741fc9618726a6eedc08c8813671e" 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">mapi_object_t * </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 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>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>
</dl>
<dl class="note" compact><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" compact><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error </dd></dl>
<p>References <a class="el" href="IMAPITable_8c_source.html#l01215">FindRow()</a>, <a class="el" href="IABContainer_8c_source.html#l00187">GetABRecipientInfo()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00081">GetContentsTable()</a>, <a class="el" href="simple__mapi_8c_source.html#l00063">GetDefaultPublicFolder()</a>, <a class="el" href="IMAPIContainer_8c_source.html#l00207">GetHierarchyTable()</a>, <a class="el" href="IMAPIProp_8c_source.html#l00059">GetProps()</a>, <a class="el" href="mapi__object_8c_source.html#l00165">mapi_object_get_session()</a>, <a class="el" href="mapi__object_8c_source.html#l00072">mapi_object_init()</a>, <a class="el" href="mapi__object_8c_source.html#l00092">mapi_object_release()</a>, <a class="el" href="IUnknown_8c_source.html#l00082">MAPIFreeBuffer()</a>, <a class="el" href="IMsgStore_8c_source.html#l00048">OpenFolder()</a>, <a class="el" href="IStoreFolder_8c_source.html#l00061">OpenMessage()</a>, <a class="el" href="IMAPITable_8c_source.html#l00051">SetColumns()</a>, and <a class="el" href="IMAPITable_8c_source.html#l00880">SortTable()</a>.</p>
<p>Referenced by <a class="el" href="freebusy_8c_source.html#l00247">IsFreeBusyConflict()</a>.</p>
</div>
</div><p>
<a class="anchor" name="657c4fc0821a80c8efd44a3ac760dfeb"></a><!-- doxytag: member="freebusy.c::IsFreeBusyConflict" ref="657c4fc0821a80c8efd44a3ac760dfeb" 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">mapi_object_t * </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 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>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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error </dd></dl>
<p>References <a class="el" href="freebusy_8c_source.html#l00348">GetFreeBusyYear()</a>, <a class="el" href="freebusy_8c_source.html#l00057">GetUserFreeBusyData()</a>, and <a class="el" href="mapi__object_8c_source.html#l00165">mapi_object_get_session()</a>.</p>
</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>
