diff options
Diffstat (limited to 'apidocs/icalrestriction_8h.html')
| -rw-r--r-- | apidocs/icalrestriction_8h.html | 259 |
1 files changed, 259 insertions, 0 deletions
diff --git a/apidocs/icalrestriction_8h.html b/apidocs/icalrestriction_8h.html new file mode 100644 index 00000000..a22ec5d6 --- /dev/null +++ b/apidocs/icalrestriction_8h.html @@ -0,0 +1,259 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.9.1"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Libical API Documentation: icalrestriction.h File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Libical API Documentation +  <span id="projectnumber">3.0</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.1 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b7a0ea939f6e83384f3c571d31a84be9.html">libical</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#typedef-members">Typedefs</a> | +<a href="#enum-members">Enumerations</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">icalrestriction.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Functions to check if an icalcomponent meets the restrictions imposed by the standard. +<a href="#details">More...</a></p> + +<p><a href="icalrestriction_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:ae380f8acbf3acc9650130ce17aa755f9"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1">icalrestriction_kind</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrestriction_8h.html#ae380f8acbf3acc9650130ce17aa755f9">icalrestriction_kind</a></td></tr> +<tr class="memdesc:ae380f8acbf3acc9650130ce17aa755f9"><td class="mdescLeft"> </td><td class="mdescRight">The kinds of icalrestrictions there are. <a href="icalrestriction_8h.html#ae380f8acbf3acc9650130ce17aa755f9">More...</a><br /></td></tr> +<tr class="separator:ae380f8acbf3acc9650130ce17aa755f9"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> +Enumerations</h2></td></tr> +<tr class="memitem:ac6d836f345770d880b446d964f685db1"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1">icalrestriction_kind</a> { <br /> +  <a class="el" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a8919e63bb091b6a78f508a212e3d2a36">ICAL_RESTRICTION_NONE</a> = 0 +, <a class="el" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1aace01bc6164411a18933716916c6c7ef">ICAL_RESTRICTION_ZERO</a> +, <a class="el" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a4bc2d60b26b48e795abf26e05dd2fe17">ICAL_RESTRICTION_ONE</a> +, <a class="el" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a15c781ad15f9a8392a620559c278199e">ICAL_RESTRICTION_ZEROPLUS</a> +, <br /> +  <a class="el" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a772dd4b4cdfe5d5a264ec237a63e6c21">ICAL_RESTRICTION_ONEPLUS</a> +, <a class="el" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a941349ba77c59b895acc1f7133421a94">ICAL_RESTRICTION_ZEROORONE</a> +, <a class="el" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a6689f5056a7239a1f7d90eed1697d4f9">ICAL_RESTRICTION_ONEEXCLUSIVE</a> +, <a class="el" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1aa27388029f05e9a1fae601d0ccbf69d9">ICAL_RESTRICTION_ONEMUTUAL</a> +, <br /> +  <a class="el" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a166b57120ae7e1f7b2d321d36bbb7bce">ICAL_RESTRICTION_UNKNOWN</a> +<br /> + }</td></tr> +<tr class="memdesc:ac6d836f345770d880b446d964f685db1"><td class="mdescLeft"> </td><td class="mdescRight">The kinds of icalrestrictions there are. <a href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1">More...</a><br /></td></tr> +<tr class="separator:ac6d836f345770d880b446d964f685db1"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a36eeedfdce2344da44fd09d9e3f18b57"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrestriction_8h.html#a36eeedfdce2344da44fd09d9e3f18b57">icalrestriction_check</a> (<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *comp)</td></tr> +<tr class="memdesc:a36eeedfdce2344da44fd09d9e3f18b57"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a given <code>VCALENDAR</code> meets all the restrictions imposed by the standard. <a href="icalrestriction_8h.html#a36eeedfdce2344da44fd09d9e3f18b57">More...</a><br /></td></tr> +<tr class="separator:a36eeedfdce2344da44fd09d9e3f18b57"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acd3882ab8b58bf0e12cb9ed48234ce2d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrestriction_8h.html#acd3882ab8b58bf0e12cb9ed48234ce2d">icalrestriction_compare</a> (<a class="el" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1">icalrestriction_kind</a> restr, int count)</td></tr> +<tr class="memdesc:acd3882ab8b58bf0e12cb9ed48234ce2d"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the given <em>count</em> is in accordance with the given restriction, <em>restr</em>. <a href="icalrestriction_8h.html#acd3882ab8b58bf0e12cb9ed48234ce2d">More...</a><br /></td></tr> +<tr class="separator:acd3882ab8b58bf0e12cb9ed48234ce2d"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Functions to check if an icalcomponent meets the restrictions imposed by the standard. </p> +</div><h2 class="groupheader">Typedef Documentation</h2> +<a id="ae380f8acbf3acc9650130ce17aa755f9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae380f8acbf3acc9650130ce17aa755f9">◆ </a></span>icalrestriction_kind</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef enum <a class="el" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1">icalrestriction_kind</a> <a class="el" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1">icalrestriction_kind</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The kinds of icalrestrictions there are. </p> +<p>These must stay in this order for icalrestriction_compare to work </p> + +</div> +</div> +<h2 class="groupheader">Enumeration Type Documentation</h2> +<a id="ac6d836f345770d880b446d964f685db1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac6d836f345770d880b446d964f685db1">◆ </a></span>icalrestriction_kind</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1">icalrestriction_kind</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The kinds of icalrestrictions there are. </p> +<p>These must stay in this order for icalrestriction_compare to work </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac6d836f345770d880b446d964f685db1a8919e63bb091b6a78f508a212e3d2a36"></a>ICAL_RESTRICTION_NONE </td><td class="fielddoc"><p>No restriction. </p> +</td></tr> +<tr><td class="fieldname"><a id="ac6d836f345770d880b446d964f685db1aace01bc6164411a18933716916c6c7ef"></a>ICAL_RESTRICTION_ZERO </td><td class="fielddoc"><p>Zero. </p> +</td></tr> +<tr><td class="fieldname"><a id="ac6d836f345770d880b446d964f685db1a4bc2d60b26b48e795abf26e05dd2fe17"></a>ICAL_RESTRICTION_ONE </td><td class="fielddoc"><p>One. </p> +</td></tr> +<tr><td class="fieldname"><a id="ac6d836f345770d880b446d964f685db1a15c781ad15f9a8392a620559c278199e"></a>ICAL_RESTRICTION_ZEROPLUS </td><td class="fielddoc"><p>Zero or more. </p> +</td></tr> +<tr><td class="fieldname"><a id="ac6d836f345770d880b446d964f685db1a772dd4b4cdfe5d5a264ec237a63e6c21"></a>ICAL_RESTRICTION_ONEPLUS </td><td class="fielddoc"><p>One or more. </p> +</td></tr> +<tr><td class="fieldname"><a id="ac6d836f345770d880b446d964f685db1a941349ba77c59b895acc1f7133421a94"></a>ICAL_RESTRICTION_ZEROORONE </td><td class="fielddoc"><p>Zero or one. </p> +</td></tr> +<tr><td class="fieldname"><a id="ac6d836f345770d880b446d964f685db1a6689f5056a7239a1f7d90eed1697d4f9"></a>ICAL_RESTRICTION_ONEEXCLUSIVE </td><td class="fielddoc"><p>Zero or one, exclusive with another property. </p> +</td></tr> +<tr><td class="fieldname"><a id="ac6d836f345770d880b446d964f685db1aa27388029f05e9a1fae601d0ccbf69d9"></a>ICAL_RESTRICTION_ONEMUTUAL </td><td class="fielddoc"><p>Zero or one, mutual with another property. </p> +</td></tr> +<tr><td class="fieldname"><a id="ac6d836f345770d880b446d964f685db1a166b57120ae7e1f7b2d321d36bbb7bce"></a>ICAL_RESTRICTION_UNKNOWN </td><td class="fielddoc"><p>Unknown. </p> +</td></tr> +</table> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a id="a36eeedfdce2344da44fd09d9e3f18b57"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a36eeedfdce2344da44fd09d9e3f18b57">◆ </a></span>icalrestriction_check()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int icalrestriction_check </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td> + <td class="paramname"><em>comp</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Checks if a given <code>VCALENDAR</code> meets all the restrictions imposed by the standard. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">comp</td><td>The <code>VCALENDAR</code> component to check </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>1 if the restrictions are met, 0 if not</dd></dl> +<dl class="section user"><dt>Error handling</dt><dd>Returns 0 and sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> if <code>NULL</code> is passed as <em>comp</em>, or if the component is not a <code>VCALENDAR</code>.</dd></dl> +<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *component = <span class="comment">// ...</span></div> +<div class="line"> </div> +<div class="line"><span class="comment">// check component</span></div> +<div class="line">assert(<a class="code" href="icalrestriction_8h.html#a36eeedfdce2344da44fd09d9e3f18b57">icalrestriction_check</a>(component) == <span class="keyword">true</span>);</div> +<div class="ttc" id="aicalrestriction_8h_html_a36eeedfdce2344da44fd09d9e3f18b57"><div class="ttname"><a href="icalrestriction_8h.html#a36eeedfdce2344da44fd09d9e3f18b57">icalrestriction_check</a></div><div class="ttdeci">int icalrestriction_check(icalcomponent *comp)</div><div class="ttdoc">Checks if a given VCALENDAR meets all the restrictions imposed by the standard.</div></div> +<div class="ttc" id="astructicalcomponent__impl_html"><div class="ttname"><a href="structicalcomponent__impl.html">icalcomponent_impl</a></div><div class="ttdef"><b>Definition:</b> icalcomponent.c:36</div></div> +</div><!-- fragment --> </dd></dl> + +</div> +</div> +<a id="acd3882ab8b58bf0e12cb9ed48234ce2d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#acd3882ab8b58bf0e12cb9ed48234ce2d">◆ </a></span>icalrestriction_compare()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int icalrestriction_compare </td> + <td>(</td> + <td class="paramtype"><a class="el" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1">icalrestriction_kind</a> </td> + <td class="paramname"><em>restr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>count</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Checks if the given <em>count</em> is in accordance with the given restriction, <em>restr</em>. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">restr</td><td>The restriction to apply to the <em>count</em> </td></tr> + <tr><td class="paramname">count</td><td>The amount present that is to be checked against the restriction </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>1 if the restriction is met, 0 if not</dd></dl> +<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line">assert(<a class="code" href="icalrestriction_8h.html#acd3882ab8b58bf0e12cb9ed48234ce2d">icalrestriction_compare</a>(ICALRESTRICTION_ONEPLUS, 5) == <span class="keyword">true</span>);</div> +<div class="line">assert(<a class="code" href="icalrestriction_8h.html#acd3882ab8b58bf0e12cb9ed48234ce2d">icalrestriction_compare</a>(ICALRESTRICTION_NONE, 3) == <span class="keyword">false</span>);</div> +<div class="ttc" id="aicalrestriction_8h_html_acd3882ab8b58bf0e12cb9ed48234ce2d"><div class="ttname"><a href="icalrestriction_8h.html#acd3882ab8b58bf0e12cb9ed48234ce2d">icalrestriction_compare</a></div><div class="ttdeci">int icalrestriction_compare(icalrestriction_kind restr, int count)</div><div class="ttdoc">Checks if the given count is in accordance with the given restriction, restr.</div></div> +</div><!-- fragment --> </dd></dl> + +</div> +</div> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Thu Oct 6 2022 11:56:07 for Libical API Documentation by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 +</small></address> +</body> +</html> |