diff options
Diffstat (limited to 'apidocs/icalerror_8h.html')
| -rw-r--r-- | apidocs/icalerror_8h.html | 117 |
1 files changed, 49 insertions, 68 deletions
diff --git a/apidocs/icalerror_8h.html b/apidocs/icalerror_8h.html index 0445d857..97191328 100644 --- a/apidocs/icalerror_8h.html +++ b/apidocs/icalerror_8h.html @@ -1,9 +1,9 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!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.8.14"/> +<meta name="generator" content="Doxygen 1.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Libical API Documentation: icalerror.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -30,7 +30,7 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.14 --> +<!-- Generated by Doxygen 1.8.15 --> <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'); @@ -90,7 +90,7 @@ Macros</h2></td></tr> #define </td><td class="memItemRight" valign="bottom"><b>ICAL_SETERROR_ISFUNC</b></td></tr> <tr class="separator:a93ada95b3e85feb69c0682689b42f7f5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad2562706150f5c5a4d9b0ca149d78e37"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a>   (*(<a class="el" href="icalerror_8h.html#aafe7575af3bfd0754deaad7eecae38e5">icalerrno_return</a>()))</td></tr> -<tr class="memdesc:ad2562706150f5c5a4d9b0ca149d78e37"><td class="mdescLeft"> </td><td class="mdescRight">Access the current <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> value. <a href="#ad2562706150f5c5a4d9b0ca149d78e37">More...</a><br /></td></tr> +<tr class="memdesc:ad2562706150f5c5a4d9b0ca149d78e37"><td class="mdescLeft"> </td><td class="mdescRight">Access the current <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> value. <a href="#ad2562706150f5c5a4d9b0ca149d78e37">More...</a><br /></td></tr> <tr class="separator:ad2562706150f5c5a4d9b0ca149d78e37"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a44c46ab691b1a16f61b796350dc01bed"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="icalerror_8h.html#a44c46ab691b1a16f61b796350dc01bed">icalerror_assert</a>(test, message)</td></tr> <tr class="memdesc:a44c46ab691b1a16f61b796350dc01bed"><td class="mdescLeft"> </td><td class="mdescRight">Assert with a message. <a href="#a44c46ab691b1a16f61b796350dc01bed">More...</a><br /></td></tr> @@ -169,7 +169,7 @@ Functions</h2></td></tr> <tr class="memdesc:a1c741ef8219eebc325e53851aa9e8f00"><td class="mdescLeft"> </td><td class="mdescRight">Prints backtrace. <a href="#a1c741ef8219eebc325e53851aa9e8f00">More...</a><br /></td></tr> <tr class="separator:a1c741ef8219eebc325e53851aa9e8f00"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aafe7575af3bfd0754deaad7eecae38e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalerror_8h.html#aafe7575af3bfd0754deaad7eecae38e5">icalerrno_return</a> (void)</td></tr> -<tr class="memdesc:aafe7575af3bfd0754deaad7eecae38e5"><td class="mdescLeft"> </td><td class="mdescRight">Return the current <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> value. <a href="#aafe7575af3bfd0754deaad7eecae38e5">More...</a><br /></td></tr> +<tr class="memdesc:aafe7575af3bfd0754deaad7eecae38e5"><td class="mdescLeft"> </td><td class="mdescRight">Return the current <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> value. <a href="#aafe7575af3bfd0754deaad7eecae38e5">More...</a><br /></td></tr> <tr class="separator:aafe7575af3bfd0754deaad7eecae38e5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae87b46acb90ce9fee0fa377fd9b57c28"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalerror_8h.html#ae87b46acb90ce9fee0fa377fd9b57c28">icalerror_clear_errno</a> (void)</td></tr> <tr class="memdesc:ae87b46acb90ce9fee0fa377fd9b57c28"><td class="mdescLeft"> </td><td class="mdescRight">Reset icalerrno to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a6748acb6af24f11fe6efbe1a19602d0b">ICAL_NO_ERROR</a>. <a href="#ae87b46acb90ce9fee0fa377fd9b57c28">More...</a><br /></td></tr> @@ -187,15 +187,15 @@ Functions</h2></td></tr> <tr class="memdesc:a44fa677ba623cdcebe9e38b03cd08389"><td class="mdescLeft"> </td><td class="mdescRight">Determine if errors are fatal. <a href="#a44fa677ba623cdcebe9e38b03cd08389">More...</a><br /></td></tr> <tr class="separator:a44fa677ba623cdcebe9e38b03cd08389"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a55b38314ff59cf335de4b0d32ebff149"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalerror_8h.html#a55b38314ff59cf335de4b0d32ebff149">icalerror_perror</a> (void)</td></tr> -<tr class="memdesc:a55b38314ff59cf335de4b0d32ebff149"><td class="mdescLeft"> </td><td class="mdescRight">Return the description string for the current error in <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a>. <a href="#a55b38314ff59cf335de4b0d32ebff149">More...</a><br /></td></tr> +<tr class="memdesc:a55b38314ff59cf335de4b0d32ebff149"><td class="mdescLeft"> </td><td class="mdescRight">Return the description string for the current error in <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a>. <a href="#a55b38314ff59cf335de4b0d32ebff149">More...</a><br /></td></tr> <tr class="separator:a55b38314ff59cf335de4b0d32ebff149"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8377dadcd17bf305d1931aa2518c321a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalerror_8h.html#a8377dadcd17bf305d1931aa2518c321a">icalerror_restore</a> (const char *error, <a class="el" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3">icalerrorstate</a> es)</td></tr> <tr class="separator:a8377dadcd17bf305d1931aa2518c321a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8266eaa216926b6703a0ef31cd99f0b2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalerror_8h.html#a8266eaa216926b6703a0ef31cd99f0b2">icalerror_set_errno</a> (<a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> x)</td></tr> -<tr class="memdesc:a8266eaa216926b6703a0ef31cd99f0b2"><td class="mdescLeft"> </td><td class="mdescRight">Sets the <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to a given error. <a href="#a8266eaa216926b6703a0ef31cd99f0b2">More...</a><br /></td></tr> +<tr class="memdesc:a8266eaa216926b6703a0ef31cd99f0b2"><td class="mdescLeft"> </td><td class="mdescRight">Sets the <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> to a given error. <a href="#a8266eaa216926b6703a0ef31cd99f0b2">More...</a><br /></td></tr> <tr class="separator:a8266eaa216926b6703a0ef31cd99f0b2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a777a41722836b68ffb27ae5a746a14b4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalerror_8h.html#a777a41722836b68ffb27ae5a746a14b4">icalerror_set_error_state</a> (<a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> error, <a class="el" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3">icalerrorstate</a> state)</td></tr> -<tr class="memdesc:a777a41722836b68ffb27ae5a746a14b4"><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3" title="Determine if an error is fatal or non-fatal. ">icalerrorstate</a> for a given <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833" title="Represents the different types of errors that can be triggered in libical. ">icalerrorenum</a> <em>error</em>. <a href="#a777a41722836b68ffb27ae5a746a14b4">More...</a><br /></td></tr> +<tr class="memdesc:a777a41722836b68ffb27ae5a746a14b4"><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3" title="Determine if an error is fatal or non-fatal.">icalerrorstate</a> for a given <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833" title="Represents the different types of errors that can be triggered in libical.">icalerrorenum</a> <em>error</em>. <a href="#a777a41722836b68ffb27ae5a746a14b4">More...</a><br /></td></tr> <tr class="separator:a777a41722836b68ffb27ae5a746a14b4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a05941b21472c45d4b3654cb7d94bf3e8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalerror_8h.html#a05941b21472c45d4b3654cb7d94bf3e8">icalerror_set_errors_are_fatal</a> (int fatal)</td></tr> <tr class="memdesc:a05941b21472c45d4b3654cb7d94bf3e8"><td class="mdescLeft"> </td><td class="mdescRight">Change if errors are fatal. <a href="#a05941b21472c45d4b3654cb7d94bf3e8">More...</a><br /></td></tr> @@ -212,7 +212,7 @@ Functions</h2></td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Error handling for libical. </p> -<p>Most routines will set the global error value <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> on errors. This variable is an enumeration; permissible values can be found in <a class="el" href="icalerror_8h.html" title="Error handling for libical. ">icalerror.h</a>. If the routine returns an enum <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833" title="Represents the different types of errors that can be triggered in libical. ">icalerrorenum</a>, then the return value will be the same as <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a>. You can use <a class="el" href="icalerror_8h.html#ace2dcbae58882ed326b4716bf54842cc" title="Find description string for error. ">icalerror_strerror()</a> to get a string that describes the error, or <a class="el" href="icalerror_8h.html#a55b38314ff59cf335de4b0d32ebff149" title="Return the description string for the current error in icalerrno. ">icalerror_perror()</a> to get a string describing the current error set in <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a>. </p> +<p>Most routines will set the global error value <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> on errors. This variable is an enumeration; permissible values can be found in <a class="el" href="icalerror_8h.html" title="Error handling for libical.">icalerror.h</a>. If the routine returns an enum <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833" title="Represents the different types of errors that can be triggered in libical.">icalerrorenum</a>, then the return value will be the same as <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a>. You can use <a class="el" href="icalerror_8h.html#ace2dcbae58882ed326b4716bf54842cc" title="Find description string for error.">icalerror_strerror()</a> to get a string that describes the error, or <a class="el" href="icalerror_8h.html#a55b38314ff59cf335de4b0d32ebff149" title="Return the description string for the current error in icalerrno.">icalerror_perror()</a> to get a string describing the current error set in <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a>. </p> </div><h2 class="groupheader">Macro Definition Documentation</h2> <a id="acb04e8e94ef9817f0a8d71c994412038"></a> <h2 class="memtitle"><span class="permalink"><a href="#acb04e8e94ef9817f0a8d71c994412038">◆ </a></span>ICAL_ERRORS_ARE_FATAL</h2> @@ -244,11 +244,10 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Access the current <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> value. </p> -<dl class="section return"><dt>Returns</dt><dd>The current <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> value </dd></dl> -<dl class="section note"><dt>Note</dt><dd>Pseudo-variable that can be used to access the current <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a>.</dd></dl> -<h3>Usage</h3> -<div class="fragment"><div class="line"><span class="keywordflow">if</span>(<a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a> == <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ac7e8ee36834bde1f2ee7b680700a8deb">ICAL_PARSE_ERROR</a>) {</div><div class="line"> <span class="comment">// ...</span></div><div class="line">}</div><div class="line"></div><div class="line"><span class="comment">// resets error</span></div><div class="line"><a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a> = <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a6748acb6af24f11fe6efbe1a19602d0b">ICAL_NO_ERROR</a>;</div></div><!-- fragment --> +<p>Access the current <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> value. </p> +<dl class="section return"><dt>Returns</dt><dd>The current <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> value </dd></dl> +<dl class="section note"><dt>Note</dt><dd>Pseudo-variable that can be used to access the current <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a>.</dd></dl> +<p>### Usage </p><div class="fragment"><div class="line"><span class="keywordflow">if</span>(<a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a> == <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ac7e8ee36834bde1f2ee7b680700a8deb">ICAL_PARSE_ERROR</a>) {</div><div class="line"> <span class="comment">// ...</span></div><div class="line">}</div><div class="line"></div><div class="line"><span class="comment">// resets error</span></div><div class="line"><a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a> = <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a6748acb6af24f11fe6efbe1a19602d0b">ICAL_NO_ERROR</a>;</div></div><!-- fragment --> </div> </div> <a id="a44c46ab691b1a16f61b796350dc01bed"></a> @@ -285,7 +284,7 @@ Functions</h2></td></tr> </table> </dd> </dl> -<p>Tests the given assertion <em>test</em>, and if it fails, prints the <em>message</em> given on <em>stderr</em> as a warning and aborts the process. This only works if <a class="el" href="icalerror_8h.html#acb04e8e94ef9817f0a8d71c994412038" title="Determines if all libical errors are fatal and lead to the process aborting. ">ICAL_ERRORS_ARE_FATAL</a> is true, otherwise does nothing. </p> +<p>Tests the given assertion <em>test</em>, and if it fails, prints the <em>message</em> given on <em>stderr</em> as a warning and aborts the process. This only works if <a class="el" href="icalerror_8h.html#acb04e8e94ef9817f0a8d71c994412038" title="Determines if all libical errors are fatal and lead to the process aborting.">ICAL_ERRORS_ARE_FATAL</a> is true, otherwise does nothing. </p> </div> </div> @@ -324,9 +323,8 @@ Functions</h2></td></tr> </table> </dd> </dl> -<p>This function checks the assertion <em>test</em>, which is used to test if the parameter <em>arg</em> is correct. If the assertion fails, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a>.</p> -<h3>Example</h3> -<div class="fragment"><div class="line"><span class="keywordtype">void</span> test_function(<a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *component) {</div><div class="line"> <a class="code" href="icalerror_8h.html#afef4004abbb97d2599d131948655ae89">icalerror_check_arg</a>(component != 0, <span class="stringliteral">"component"</span>);</div><div class="line"></div><div class="line"> <span class="comment">// use component</span></div><div class="line">}</div></div><!-- fragment --> +<p>This function checks the assertion <em>test</em>, which is used to test if the parameter <em>arg</em> is correct. If the assertion fails, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a>.</p> +<p>### Example </p><div class="fragment"><div class="line"><span class="keywordtype">void</span> test_function(<a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *component) {</div><div class="line"> <a class="code" href="icalerror_8h.html#afef4004abbb97d2599d131948655ae89">icalerror_check_arg</a>(component != 0, <span class="stringliteral">"component"</span>);</div><div class="line"></div><div class="line"> <span class="comment">// use component</span></div><div class="line">}</div></div><!-- fragment --> </div> </div> <a id="ae163052ebae24e2026bf54108b10b914"></a> @@ -371,8 +369,7 @@ Functions</h2></td></tr> </dd> </dl> <p>This function checks the assertion <em>test</em>, which is used to test if the parameter <em>arg</em> is correct. If the assertion fails, it aborts the process with <code>assert(0)</code> and causes the enclosing function to return <em>error</em>.</p> -<h3>Example</h3> -<div class="fragment"><div class="line"><a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *test_function(<a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *component) {</div><div class="line"> <a class="code" href="icalerror_8h.html#ae163052ebae24e2026bf54108b10b914">icalerror_check_arg_re</a>(component != 0, <span class="stringliteral">"component"</span>, NULL);</div><div class="line"></div><div class="line"> <span class="comment">// use component</span></div><div class="line"> <span class="keywordflow">return</span> icalcomponent_get_first_real_component(component);</div><div class="line">}</div></div><!-- fragment --> +<p>### Example </p><div class="fragment"><div class="line"><a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *test_function(<a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *component) {</div><div class="line"> <a class="code" href="icalerror_8h.html#ae163052ebae24e2026bf54108b10b914">icalerror_check_arg_re</a>(component != 0, <span class="stringliteral">"component"</span>, NULL);</div><div class="line"></div><div class="line"> <span class="comment">// use component</span></div><div class="line"> <span class="keywordflow">return</span> icalcomponent_get_first_real_component(component);</div><div class="line">}</div></div><!-- fragment --> </div> </div> <a id="a00245be23d5c2d4801c9ed74e1da6f6a"></a> @@ -410,9 +407,8 @@ Functions</h2></td></tr> </table> </dd> </dl> -<p>This function checks the assertion <em>test</em>, which is used to test if the parameter <em>arg</em> is correct. If the assertion fails, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a> and causes the enclosing function to return <code>void</code>.</p> -<h3>Example</h3> -<div class="fragment"><div class="line"><span class="keywordtype">void</span> test_function(<a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *component) {</div><div class="line"> <a class="code" href="icalerror_8h.html#a00245be23d5c2d4801c9ed74e1da6f6a">icalerror_check_arg_rv</a>(component != 0, <span class="stringliteral">"component"</span>);</div><div class="line"></div><div class="line"> <span class="comment">// use component</span></div><div class="line">}</div></div><!-- fragment --> +<p>This function checks the assertion <em>test</em>, which is used to test if the parameter <em>arg</em> is correct. If the assertion fails, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a> and causes the enclosing function to return <code>void</code>.</p> +<p>### Example </p><div class="fragment"><div class="line"><span class="keywordtype">void</span> test_function(<a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *component) {</div><div class="line"> <a class="code" href="icalerror_8h.html#a00245be23d5c2d4801c9ed74e1da6f6a">icalerror_check_arg_rv</a>(component != 0, <span class="stringliteral">"component"</span>);</div><div class="line"></div><div class="line"> <span class="comment">// use component</span></div><div class="line">}</div></div><!-- fragment --> </div> </div> <a id="a7a71f70509be32e3e54edbaf3b45571a"></a> @@ -457,9 +453,8 @@ Functions</h2></td></tr> </table> </dd> </dl> -<p>This function checks the assertion <em>test</em>, which is used to test if the parameter <em>arg</em> is correct. If the assertion fails, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a> and causes the enclosing function to return <em>x</em>.</p> -<h3>Example</h3> -<div class="fragment"><div class="line"><a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *test_function(<a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *component) {</div><div class="line"> <a class="code" href="icalerror_8h.html#a7a71f70509be32e3e54edbaf3b45571a">icalerror_check_arg_rx</a>(component != 0, <span class="stringliteral">"component"</span>, NULL);</div><div class="line"></div><div class="line"> <span class="comment">// use component</span></div><div class="line"> <span class="keywordflow">return</span> icalcomponent_get_first_real_component(component);</div><div class="line">}</div></div><!-- fragment --> +<p>This function checks the assertion <em>test</em>, which is used to test if the parameter <em>arg</em> is correct. If the assertion fails, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a> and causes the enclosing function to return <em>x</em>.</p> +<p>### Example </p><div class="fragment"><div class="line"><a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *test_function(<a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *component) {</div><div class="line"> <a class="code" href="icalerror_8h.html#a7a71f70509be32e3e54edbaf3b45571a">icalerror_check_arg_rx</a>(component != 0, <span class="stringliteral">"component"</span>, NULL);</div><div class="line"></div><div class="line"> <span class="comment">// use component</span></div><div class="line"> <span class="keywordflow">return</span> icalcomponent_get_first_real_component(component);</div><div class="line">}</div></div><!-- fragment --> </div> </div> <a id="a95198bf515920804672520856c300666"></a> @@ -497,9 +492,8 @@ Functions</h2></td></tr> </table> </dd> </dl> -<p>This function checks the assertion <em>test</em>, which is used to test if the parameter <em>arg</em> is correct. If the assertion fails, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a> and causes the enclosing function to return <code>0</code>.</p> -<h3>Example</h3> -<div class="fragment"><div class="line"><span class="keywordtype">int</span> test_function(<a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *component) {</div><div class="line"> <a class="code" href="icalerror_8h.html#a95198bf515920804672520856c300666">icalerror_check_arg_rz</a>(component != 0, <span class="stringliteral">"component"</span>);</div><div class="line"></div><div class="line"> <span class="comment">// use component</span></div><div class="line"> <span class="keywordflow">return</span> icalcomponent_count_kinds(component, ICAL_ANY_COMPONENT);</div><div class="line">}</div></div><!-- fragment --> +<p>This function checks the assertion <em>test</em>, which is used to test if the parameter <em>arg</em> is correct. If the assertion fails, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a> and causes the enclosing function to return <code>0</code>.</p> +<p>### Example </p><div class="fragment"><div class="line"><span class="keywordtype">int</span> test_function(<a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *component) {</div><div class="line"> <a class="code" href="icalerror_8h.html#a95198bf515920804672520856c300666">icalerror_check_arg_rz</a>(component != 0, <span class="stringliteral">"component"</span>);</div><div class="line"></div><div class="line"> <span class="comment">// use component</span></div><div class="line"> <span class="keywordflow">return</span> icalcomponent_count_kinds(component, ICAL_ANY_COMPONENT);</div><div class="line">}</div></div><!-- fragment --> </div> </div> <a id="a2ab760137cd4f66d205ef00235a0ecd4"></a> @@ -525,8 +519,7 @@ Functions</h2></td></tr> </table> </dd> </dl> -<h3>Usage</h3> -<div class="fragment"><div class="line"><a class="code" href="icalerror_8h.html#a2ab760137cd4f66d205ef00235a0ecd4">icalerror_warn</a>(<span class="stringliteral">"Non-standard tag encountered"</span>);</div></div><!-- fragment --> +<p>### Usage </p><div class="fragment"><div class="line"><a class="code" href="icalerror_8h.html#a2ab760137cd4f66d205ef00235a0ecd4">icalerror_warn</a>(<span class="stringliteral">"Non-standard tag encountered"</span>);</div></div><!-- fragment --> </div> </div> <h2 class="groupheader">Enumeration Type Documentation</h2> @@ -543,7 +536,7 @@ Functions</h2></td></tr> </div><div class="memdoc"> <p>Represents the different types of errors that can be triggered in libical. </p> -<p>Each of these values represent a different type of error, which is stored in <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> on exit of the library function (or can be returned, but if it is, <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> is also set). </p> +<p>Each of these values represent a different type of error, which is stored in <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> on exit of the library function (or can be returned, but if it is, <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> is also set). </p> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a601c122fcea522513b1b7732fa23e833a6748acb6af24f11fe6efbe1a19602d0b"></a>ICAL_NO_ERROR </td><td class="fielddoc"><p>No error happened </p> </td></tr> @@ -616,8 +609,7 @@ Functions</h2></td></tr> <p>Prints backtrace. </p> <dl class="section note"><dt>Note</dt><dd>Only works on systems that support it (HAVE_BACKTRACE enabled).</dd></dl> -<h3>Usage</h3> -<div class="fragment"><div class="line"><span class="keywordflow">if</span>(<a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a> != <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a6748acb6af24f11fe6efbe1a19602d0b">ICAL_NO_ERROR</a>) {</div><div class="line"> <a class="code" href="icalerror_8h.html#a1c741ef8219eebc325e53851aa9e8f00">ical_bt</a>();</div><div class="line">}</div></div><!-- fragment --> +<p>### Usage </p><div class="fragment"><div class="line"><span class="keywordflow">if</span>(<a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a> != <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a6748acb6af24f11fe6efbe1a19602d0b">ICAL_NO_ERROR</a>) {</div><div class="line"> <a class="code" href="icalerror_8h.html#a1c741ef8219eebc325e53851aa9e8f00">ical_bt</a>();</div><div class="line">}</div></div><!-- fragment --> </div> </div> <a id="aafe7575af3bfd0754deaad7eecae38e5"></a> @@ -636,11 +628,10 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Return the current <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> value. </p> -<dl class="section return"><dt>Returns</dt><dd>A pointer to the current <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> value</dd></dl> -<p>Yields a pointer to the current <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> value. This can be used to access (read from and write to) it.</p> -<h3>Examples</h3> -<div class="fragment"><div class="line">assert(*<a class="code" href="icalerror_8h.html#aafe7575af3bfd0754deaad7eecae38e5">icalerrno_return</a>() == <a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a>);</div></div><!-- fragment --> +<p>Return the current <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> value. </p> +<dl class="section return"><dt>Returns</dt><dd>A pointer to the current <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> value</dd></dl> +<p>Yields a pointer to the current <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> value. This can be used to access (read from and write to) it.</p> +<p>### Examples </p><div class="fragment"><div class="line">assert(*<a class="code" href="icalerror_8h.html#aafe7575af3bfd0754deaad7eecae38e5">icalerrno_return</a>() == <a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a>);</div></div><!-- fragment --> </div> </div> <a id="ae87b46acb90ce9fee0fa377fd9b57c28"></a> @@ -660,8 +651,7 @@ Functions</h2></td></tr> </div><div class="memdoc"> <p>Reset icalerrno to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a6748acb6af24f11fe6efbe1a19602d0b">ICAL_NO_ERROR</a>. </p> -<h3>Usage</h3> -<div class="fragment"><div class="line"><span class="keywordflow">if</span>(<a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a> == <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ac7e8ee36834bde1f2ee7b680700a8deb">ICAL_PARSE_ERROR</a>) {</div><div class="line"> <span class="comment">// ignore parsing errors</span></div><div class="line"> <a class="code" href="icalerror_8h.html#ae87b46acb90ce9fee0fa377fd9b57c28">icalerror_clear_errno</a>();</div><div class="line">}</div></div><!-- fragment --> +<p>### Usage </p><div class="fragment"><div class="line"><span class="keywordflow">if</span>(<a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a> == <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ac7e8ee36834bde1f2ee7b680700a8deb">ICAL_PARSE_ERROR</a>) {</div><div class="line"> <span class="comment">// ignore parsing errors</span></div><div class="line"> <a class="code" href="icalerror_8h.html#ae87b46acb90ce9fee0fa377fd9b57c28">icalerror_clear_errno</a>();</div><div class="line">}</div></div><!-- fragment --> </div> </div> <a id="a0cbc33f05e014e767bd92b04bfb92f62"></a> @@ -708,10 +698,9 @@ Functions</h2></td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833" title="Represents the different types of errors that can be triggered in libical. ">icalerrorenum</a> representing the error</dd></dl> +<dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833" title="Represents the different types of errors that can be triggered in libical.">icalerrorenum</a> representing the error</dd></dl> <dl class="section user"><dt>Error handling</dt><dd>If the error specified in <em>str</em> can't be found, instead <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ab2452506d4ad884b16da429749bfb551">ICAL_UNKNOWN_ERROR</a> is returned.</dd></dl> -<h3>Usage</h3> -<div class="fragment"><div class="line">assert(<a class="code" href="icalerror_8h.html#a9b60700869241af095f0604f35b1c446">icalerror_error_from_string</a>(<span class="stringliteral">"PARSE"</span>) == <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ac7e8ee36834bde1f2ee7b680700a8deb">ICAL_PARSE_ERROR</a>);</div><div class="line">assert(<a class="code" href="icalerror_8h.html#a9b60700869241af095f0604f35b1c446">icalerror_error_from_string</a>(<span class="stringliteral">"NONSENSE"</span>) == <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ab2452506d4ad884b16da429749bfb551">ICAL_UNKNOWN_ERROR</a>);</div></div><!-- fragment --> +<p>### Usage </p><div class="fragment"><div class="line">assert(<a class="code" href="icalerror_8h.html#a9b60700869241af095f0604f35b1c446">icalerror_error_from_string</a>(<span class="stringliteral">"PARSE"</span>) == <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ac7e8ee36834bde1f2ee7b680700a8deb">ICAL_PARSE_ERROR</a>);</div><div class="line">assert(<a class="code" href="icalerror_8h.html#a9b60700869241af095f0604f35b1c446">icalerror_error_from_string</a>(<span class="stringliteral">"NONSENSE"</span>) == <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ab2452506d4ad884b16da429749bfb551">ICAL_UNKNOWN_ERROR</a>);</div></div><!-- fragment --> </div> </div> <a id="a5fe3cbc229f74250b59c077e21abf82d"></a> @@ -759,8 +748,7 @@ Functions</h2></td></tr> <p>Determine if errors are fatal. </p> <dl class="section return"><dt>Returns</dt><dd>True if libical errors are fatal</dd></dl> -<h3>Usage</h3> -<div class="fragment"><div class="line"><span class="keywordflow">if</span>(<a class="code" href="icalerror_8h.html#a44fa677ba623cdcebe9e38b03cd08389">icalerror_get_errors_are_fatal</a>()) {</div><div class="line"> <span class="comment">// since errors are fatal, this will abort the</span></div><div class="line"> <span class="comment">// program.</span></div><div class="line"> <a class="code" href="icalerror_8h.html#a8266eaa216926b6703a0ef31cd99f0b2">icalerror_set_errno</a>(<a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ac7e8ee36834bde1f2ee7b680700a8deb">ICAL_PARSE_ERROR</a>);</div><div class="line">}</div></div><!-- fragment --> +<p>### Usage </p><div class="fragment"><div class="line"><span class="keywordflow">if</span>(<a class="code" href="icalerror_8h.html#a44fa677ba623cdcebe9e38b03cd08389">icalerror_get_errors_are_fatal</a>()) {</div><div class="line"> <span class="comment">// since errors are fatal, this will abort the</span></div><div class="line"> <span class="comment">// program.</span></div><div class="line"> <a class="code" href="icalerror_8h.html#a8266eaa216926b6703a0ef31cd99f0b2">icalerror_set_errno</a>(<a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ac7e8ee36834bde1f2ee7b680700a8deb">ICAL_PARSE_ERROR</a>);</div><div class="line">}</div></div><!-- fragment --> </div> </div> <a id="a55b38314ff59cf335de4b0d32ebff149"></a> @@ -779,11 +767,10 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Return the description string for the current error in <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a>. </p> +<p>Return the description string for the current error in <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a>. </p> <dl class="section user"><dt>Error handling</dt><dd>If the type of error <em>e</em> wasn't found, it returns the description for <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ab2452506d4ad884b16da429749bfb551">ICAL_UNKNOWN_ERROR</a>.</dd></dl> <dl class="section user"><dt>Ownership</dt><dd>The string that is returned is owned by the library and must not be free'd() by the user.</dd></dl> -<h3>Usage</h3> -<div class="fragment"><div class="line"><span class="keywordflow">if</span>(<a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a> != <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a6748acb6af24f11fe6efbe1a19602d0b">ICAL_NO_ERROR</a>) {</div><div class="line"> printf(<span class="stringliteral">"%s\n"</span>, <a class="code" href="icalerror_8h.html#a55b38314ff59cf335de4b0d32ebff149">icalerror_perror</a>());</div><div class="line">}</div></div><!-- fragment --> +<p>### Usage </p><div class="fragment"><div class="line"><span class="keywordflow">if</span>(<a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a> != <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a6748acb6af24f11fe6efbe1a19602d0b">ICAL_NO_ERROR</a>) {</div><div class="line"> printf(<span class="stringliteral">"%s\n"</span>, <a class="code" href="icalerror_8h.html#a55b38314ff59cf335de4b0d32ebff149">icalerror_perror</a>());</div><div class="line">}</div></div><!-- fragment --> </div> </div> <a id="a8377dadcd17bf305d1931aa2518c321a"></a> @@ -818,9 +805,8 @@ Functions</h2></td></tr> </table> </dd> </dl> -<p>Calling the function changes the <a class="el" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3" title="Determine if an error is fatal or non-fatal. ">icalerrorstate</a> of the given error.</p> -<h3>Usage</h3> -<div class="fragment"><div class="line"><span class="comment">// suppress internal errors</span></div><div class="line"><a class="code" href="icalerror_8h.html#af226f2c41272dabecd03ec9807d3a1e2">icalerror_supress</a>(<span class="stringliteral">"INTERNAL"</span>);</div><div class="line"></div><div class="line"><span class="comment">// ...</span></div><div class="line"></div><div class="line"><span class="comment">// restore internal errors</span></div><div class="line"><a class="code" href="icalerror_8h.html#a8377dadcd17bf305d1931aa2518c321a">icalerror_restore</a>(<span class="stringliteral">"INTERNAL"</span>, <a class="code" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3aa8624e525ff7c52b30310134230ba1e6">ICAL_ERROR_DEFAULT</a>);</div></div><!-- fragment --> +<p>Calling the function changes the <a class="el" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3" title="Determine if an error is fatal or non-fatal.">icalerrorstate</a> of the given error.</p> +<p>### Usage </p><div class="fragment"><div class="line"><span class="comment">// suppress internal errors</span></div><div class="line"><a class="code" href="icalerror_8h.html#af226f2c41272dabecd03ec9807d3a1e2">icalerror_supress</a>(<span class="stringliteral">"INTERNAL"</span>);</div><div class="line"></div><div class="line"><span class="comment">// ...</span></div><div class="line"></div><div class="line"><span class="comment">// restore internal errors</span></div><div class="line"><a class="code" href="icalerror_8h.html#a8377dadcd17bf305d1931aa2518c321a">icalerror_restore</a>(<span class="stringliteral">"INTERNAL"</span>, <a class="code" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3aa8624e525ff7c52b30310134230ba1e6">ICAL_ERROR_DEFAULT</a>);</div></div><!-- fragment --> </div> </div> <a id="a8266eaa216926b6703a0ef31cd99f0b2"></a> @@ -839,16 +825,15 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Sets the <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to a given error. </p> +<p>Sets the <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> to a given error. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramname">x</td><td>The error to set <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to</td></tr> + <tr><td class="paramname">x</td><td>The error to set <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> to</td></tr> </table> </dd> </dl> -<p>Sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to the error given in <em>x</em>. Additionally, if the error is an <a class="el" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3a6a2c3dc27d17100317eadcc4156a9442">ICAL_ERROR_FATAL</a> or if it's an <a class="el" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3aa8624e525ff7c52b30310134230ba1e6">ICAL_ERROR_DEFAULT</a> and <a class="el" href="icalerror_8h.html#acb04e8e94ef9817f0a8d71c994412038" title="Determines if all libical errors are fatal and lead to the process aborting. ">ICAL_ERRORS_ARE_FATAL</a> is true, it prints a warning to <em>stderr</em> and aborts the process.</p> -<h3>Usage</h3> -<div class="fragment"><div class="line"><a class="code" href="icalerror_8h.html#a8266eaa216926b6703a0ef31cd99f0b2">icalerror_set_errno</a>(<a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ac7e8ee36834bde1f2ee7b680700a8deb">ICAL_PARSE_ERROR</a>);</div></div><!-- fragment --> +<p>Sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> to the error given in <em>x</em>. Additionally, if the error is an <a class="el" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3a6a2c3dc27d17100317eadcc4156a9442">ICAL_ERROR_FATAL</a> or if it's an <a class="el" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3aa8624e525ff7c52b30310134230ba1e6">ICAL_ERROR_DEFAULT</a> and <a class="el" href="icalerror_8h.html#acb04e8e94ef9817f0a8d71c994412038" title="Determines if all libical errors are fatal and lead to the process aborting.">ICAL_ERRORS_ARE_FATAL</a> is true, it prints a warning to <em>stderr</em> and aborts the process.</p> +<p>### Usage </p><div class="fragment"><div class="line"><a class="code" href="icalerror_8h.html#a8266eaa216926b6703a0ef31cd99f0b2">icalerror_set_errno</a>(<a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ac7e8ee36834bde1f2ee7b680700a8deb">ICAL_PARSE_ERROR</a>);</div></div><!-- fragment --> </div> </div> <a id="a777a41722836b68ffb27ae5a746a14b4"></a> @@ -877,7 +862,7 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Set the <a class="el" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3" title="Determine if an error is fatal or non-fatal. ">icalerrorstate</a> for a given <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833" title="Represents the different types of errors that can be triggered in libical. ">icalerrorenum</a> <em>error</em>. </p> +<p>Set the <a class="el" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3" title="Determine if an error is fatal or non-fatal.">icalerrorstate</a> for a given <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833" title="Represents the different types of errors that can be triggered in libical.">icalerrorenum</a> <em>error</em>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">error</td><td>The error to change </td></tr> @@ -886,8 +871,7 @@ Functions</h2></td></tr> </dd> </dl> <p>Sets the severity of a given error. For example, it can be used to set the severity of an <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ac7e8ee36834bde1f2ee7b680700a8deb">ICAL_PARSE_ERROR</a> to be an <a class="el" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3aee5a5c75923a46b30105a272b75339b6">ICAL_ERROR_NONFATAL</a>.</p> -<h3>Usage</h3> -<div class="fragment"><div class="line"><a class="code" href="icalerror_8h.html#a777a41722836b68ffb27ae5a746a14b4">icalerror_set_error_state</a>(<a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ac7e8ee36834bde1f2ee7b680700a8deb">ICAL_PARSE_ERROR</a>, <a class="code" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3aee5a5c75923a46b30105a272b75339b6">ICAL_ERROR_NONFATAL</a>);</div></div><!-- fragment --> +<p>### Usage </p><div class="fragment"><div class="line"><a class="code" href="icalerror_8h.html#a777a41722836b68ffb27ae5a746a14b4">icalerror_set_error_state</a>(<a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ac7e8ee36834bde1f2ee7b680700a8deb">ICAL_PARSE_ERROR</a>, <a class="code" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3aee5a5c75923a46b30105a272b75339b6">ICAL_ERROR_NONFATAL</a>);</div></div><!-- fragment --> </div> </div> <a id="a05941b21472c45d4b3654cb7d94bf3e8"></a> @@ -914,8 +898,7 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section warning"><dt>Warning</dt><dd>NOT THREAD SAFE: it is recommended that you do not change this in a multithreaded program.</dd></dl> -<h3>Usage</h3> -<div class="fragment"><div class="line"><a class="code" href="icalerror_8h.html#a05941b21472c45d4b3654cb7d94bf3e8">icalerror_set_errors_are_fatal</a>(<span class="keyword">true</span>); <span class="comment">// default</span></div><div class="line"><a class="code" href="icalerror_8h.html#a05941b21472c45d4b3654cb7d94bf3e8">icalerror_set_errors_are_fatal</a>(<span class="keyword">false</span>);</div></div><!-- fragment --> +<p>### Usage </p><div class="fragment"><div class="line"><a class="code" href="icalerror_8h.html#a05941b21472c45d4b3654cb7d94bf3e8">icalerror_set_errors_are_fatal</a>(<span class="keyword">true</span>); <span class="comment">// default</span></div><div class="line"><a class="code" href="icalerror_8h.html#a05941b21472c45d4b3654cb7d94bf3e8">icalerror_set_errors_are_fatal</a>(<span class="keyword">false</span>);</div></div><!-- fragment --> </div> </div> <a id="a9102f6b721a280151c7858860707171b"></a> @@ -935,7 +918,7 @@ Functions</h2></td></tr> </div><div class="memdoc"> <p>Triggered before any error is called. </p> -<p>This routine is called before any error is triggered. It is called by <a class="el" href="icalerror_8h.html#a8266eaa216926b6703a0ef31cd99f0b2" title="Sets the icalerrno to a given error. ">icalerror_set_errno()</a>, so it does not appear in all of the macros below.</p> +<p>This routine is called before any error is triggered. It is called by <a class="el" href="icalerror_8h.html#a8266eaa216926b6703a0ef31cd99f0b2" title="Sets the icalerrno to a given error.">icalerror_set_errno()</a>, so it does not appear in all of the macros below.</p> <p>This routine can be used while debugging by setting a breakpoint here. </p> </div> @@ -966,8 +949,7 @@ Functions</h2></td></tr> <dl class="section return"><dt>Returns</dt><dd>A string describing the error that occurred</dd></dl> <dl class="section user"><dt>Error handling</dt><dd>If the type of error <em>e</em> wasn't found, it returns the description for <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833ab2452506d4ad884b16da429749bfb551">ICAL_UNKNOWN_ERROR</a>.</dd></dl> <dl class="section user"><dt>Ownership</dt><dd>The string that is returned is owned by the library and must not be free'd() by the user.</dd></dl> -<h3>Usage</h3> -<div class="fragment"><div class="line"><span class="keywordflow">if</span>(<a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a> != <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a6748acb6af24f11fe6efbe1a19602d0b">ICAL_NO_ERROR</a>) {</div><div class="line"> printf(<span class="stringliteral">"%s\n"</span>, <a class="code" href="icalerror_8h.html#ace2dcbae58882ed326b4716bf54842cc">icalerror_strerror</a>(<a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a>));</div><div class="line">}</div></div><!-- fragment --> +<p>### Usage </p><div class="fragment"><div class="line"><span class="keywordflow">if</span>(<a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a> != <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a6748acb6af24f11fe6efbe1a19602d0b">ICAL_NO_ERROR</a>) {</div><div class="line"> printf(<span class="stringliteral">"%s\n"</span>, <a class="code" href="icalerror_8h.html#ace2dcbae58882ed326b4716bf54842cc">icalerror_strerror</a>(<a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a>));</div><div class="line">}</div></div><!-- fragment --> </div> </div> <a id="af226f2c41272dabecd03ec9807d3a1e2"></a> @@ -995,8 +977,7 @@ Functions</h2></td></tr> </dl> <dl class="section return"><dt>Returns</dt><dd>The previous icalerrorstate (severity)</dd></dl> <p>Calling this function causes the given error to be listed as <a class="el" href="icalerror_8h.html#a3cb9a92508be773fbb4dba7c658443d3aee5a5c75923a46b30105a272b75339b6">ICAL_ERROR_NONFATAL</a>, and thus suppressed. Error states can be restored with <a class="el" href="icalerror_8h.html#a8377dadcd17bf305d1931aa2518c321a">icalerror_restore()</a>.</p> -<h3>Usage</h3> -<div class="fragment"><div class="line"><span class="comment">// suppresses internal errors</span></div><div class="line"><a class="code" href="icalerror_8h.html#af226f2c41272dabecd03ec9807d3a1e2">icalerror_supress</a>(<span class="stringliteral">"INTERNAL"</span>);</div></div><!-- fragment --> +<p>### Usage </p><div class="fragment"><div class="line"><span class="comment">// suppresses internal errors</span></div><div class="line"><a class="code" href="icalerror_8h.html#af226f2c41272dabecd03ec9807d3a1e2">icalerror_supress</a>(<span class="stringliteral">"INTERNAL"</span>);</div></div><!-- fragment --> </div> </div> </div><!-- contents --> @@ -1004,7 +985,7 @@ Functions</h2></td></tr> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> -</a> 1.8.14 +</a> 1.8.15 </small></address> </body> </html> |