2014-02-20 20:09:24 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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" / >
< title > libpcp: FATALS< / 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 = "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 style = "padding-left: 0.5em;" >
< div id = "projectname" > libpcp
  < span id = "projectnumber" > 0.2.1< / span >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
< div id = "navrow1" class = "tabs" >
< ul class = "tablist" >
< li > < a href = "index.html" > < span > Main  Page< / span > < / a > < / li >
< li > < a href = "modules.html" > < span > Modules< / span > < / a > < / li >
< li > < a href = "annotated.html" > < span > Classes< / span > < / a > < / li >
< li > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< / ul >
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#func-members" > Functions< / a > |
< a href = "#var-members" > Variables< / a > < / div >
< div class = "headertitle" >
< div class = "title" > FATALS< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > A couple of functions to catch errors and display them.
< a href = "#details" > More...< / a > < / p >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
< tr class = "memitem:ga677da14e8c4326bde43622f233f1ead3" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__FATALS.html#ga677da14e8c4326bde43622f233f1ead3" > fatal< / a > (const char *fmt,...)< / td > < / tr >
< tr class = "memdesc:ga677da14e8c4326bde43622f233f1ead3" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set an error message. < a href = "#ga677da14e8c4326bde43622f233f1ead3" > < / a > < br / > < / td > < / tr >
< tr class = "separator:ga677da14e8c4326bde43622f233f1ead3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga0ea01da59af8a06c55258d78da6cb0cb" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__FATALS.html#ga0ea01da59af8a06c55258d78da6cb0cb" > fatals_ifany< / a > ()< / td > < / tr >
< tr class = "memdesc:ga0ea01da59af8a06c55258d78da6cb0cb" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Prints error messages to STDERR, if there are some. < a href = "#ga0ea01da59af8a06c55258d78da6cb0cb" > < / a > < br / > < / td > < / tr >
< tr class = "separator:ga0ea01da59af8a06c55258d78da6cb0cb" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga778f5515a4d5e03cb7baf53855e05375" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__FATALS.html#ga778f5515a4d5e03cb7baf53855e05375" > fatals_reset< / a > ()< / td > < / tr >
< tr class = "memdesc:ga778f5515a4d5e03cb7baf53855e05375" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Reset the error variables. < a href = "#ga778f5515a4d5e03cb7baf53855e05375" > < / a > < br / > < / td > < / tr >
< tr class = "separator:ga778f5515a4d5e03cb7baf53855e05375" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gae354ce0c89d6ee013f6bca066507a813" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__FATALS.html#gae354ce0c89d6ee013f6bca066507a813" > fatals_done< / a > ()< / td > < / tr >
< tr class = "memdesc:gae354ce0c89d6ee013f6bca066507a813" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Cleans up memory allocation of global error variables. < a href = "#gae354ce0c89d6ee013f6bca066507a813" > < / a > < br / > < / td > < / tr >
< tr class = "separator:gae354ce0c89d6ee013f6bca066507a813" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "var-members" > < / a >
Variables< / h2 > < / td > < / tr >
< tr class = "memitem:gaa82cfd45780516d548fca7e395dcd737" > < td class = "memItemLeft" align = "right" valign = "top" > char *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__FATALS.html#gaa82cfd45780516d548fca7e395dcd737" > PCP_ERR< / a > < / td > < / tr >
< tr class = "memdesc:gaa82cfd45780516d548fca7e395dcd737" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Global variable holding the last error message. < a href = "#gaa82cfd45780516d548fca7e395dcd737" > < / a > < br / > < / td > < / tr >
< tr class = "separator:gaa82cfd45780516d548fca7e395dcd737" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga370bd749bea64884ea94a420197e5a1f" > < td class = "memItemLeft" align = "right" valign = "top" > byte  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__FATALS.html#ga370bd749bea64884ea94a420197e5a1f" > PCP_ERRSET< / a > < / td > < / tr >
< tr class = "memdesc:ga370bd749bea64884ea94a420197e5a1f" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Global variable indicating if an error occurred. < a href = "#ga370bd749bea64884ea94a420197e5a1f" > < / a > < br / > < / td > < / tr >
< tr class = "separator:ga370bd749bea64884ea94a420197e5a1f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gabdc19db902d5cdd179bd48d3d156c3a0" > < td class = "memItemLeft" align = "right" valign = "top" > int  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__FATALS.html#gabdc19db902d5cdd179bd48d3d156c3a0" > PCP_EXIT< / a > < / td > < / tr >
< tr class = "memdesc:gabdc19db902d5cdd179bd48d3d156c3a0" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Exitcode for the pcp commandline utility. < a href = "#gabdc19db902d5cdd179bd48d3d156c3a0" > < / a > < br / > < / td > < / tr >
< tr class = "separator:gabdc19db902d5cdd179bd48d3d156c3a0" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< p > A couple of functions to catch errors and display them. < / p >
< h2 class = "groupheader" > Function Documentation< / h2 >
< a class = "anchor" id = "ga677da14e8c4326bde43622f233f1ead3" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void fatal < / td >
< td > (< / td >
< td class = "paramtype" > const char *  < / td >
< td class = "paramname" > < em > fmt< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" >   < / td >
< td class = "paramname" > < em > ...< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Set an error message. < / p >
< p > This function gets a printf() like error message, which it stores in the global PCP_ERR variable and sets PCP_ERRSET to 1.< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > fmt< / td > < td > printf() like format description.< / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > ...< / td > < td > format parameters, if any. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
< a class = "anchor" id = "gae354ce0c89d6ee013f6bca066507a813" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void fatals_done < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Cleans up memory allocation of global error variables. < / p >
< / div >
< / div >
< a class = "anchor" id = "ga0ea01da59af8a06c55258d78da6cb0cb" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void fatals_ifany < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Prints error messages to STDERR, if there are some. < / p >
< p > FIXME: add something like this which returns the message. < / p >
< / div >
< / div >
< a class = "anchor" id = "ga778f5515a4d5e03cb7baf53855e05375" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void fatals_reset < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Reset the error variables. < / p >
< p > This can be used to ignore previous errors. Use with care. < / p >
< / div >
< / div >
< h2 class = "groupheader" > Variable Documentation< / h2 >
< a class = "anchor" id = "gaa82cfd45780516d548fca7e395dcd737" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > PCP_ERR< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Global variable holding the last error message. < / p >
< p > Can be retrieved with < a class = "el" href = "group__FATALS.html#ga0ea01da59af8a06c55258d78da6cb0cb" title = "Prints error messages to STDERR, if there are some." > fatals_ifany()< / a > . < / p >
< / div >
< / div >
< a class = "anchor" id = "ga370bd749bea64884ea94a420197e5a1f" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > PCP_ERRSET< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Global variable indicating if an error occurred. < / p >
< / div >
< / div >
< a class = "anchor" id = "gabdc19db902d5cdd179bd48d3d156c3a0" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > PCP_EXIT< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Exitcode for the pcp commandline utility. < / p >
< / div >
< / div >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2014-02-20 21:02:52 +01:00
Generated on Thu Feb 20 2014 20:58:12 for libpcp by   < a href = "http://www.doxygen.org/index.html" >
2014-02-20 20:09:24 +01:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / >
< / a > 1.8.2
< / small > < / address >
< / body >
< / html >
