1ae771770SStanislav Sedov<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2ae771770SStanislav Sedov<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 3ae771770SStanislav Sedov<title>HeimdalKerberos5library: Heimdal Kerberos 5 error reporting functions</title> 4ae771770SStanislav Sedov<link href="doxygen.css" rel="stylesheet" type="text/css"> 5ae771770SStanislav Sedov<link href="tabs.css" rel="stylesheet" type="text/css"> 6ae771770SStanislav Sedov</head><body> 7ae771770SStanislav Sedov<p> 8ae771770SStanislav Sedov<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a> 9ae771770SStanislav Sedov</p> 10ae771770SStanislav Sedov<!-- end of header marker --> 11ae771770SStanislav Sedov<!-- Generated by Doxygen 1.5.6 --> 12ae771770SStanislav Sedov<div class="navigation" id="top"> 13ae771770SStanislav Sedov <div class="tabs"> 14ae771770SStanislav Sedov <ul> 15ae771770SStanislav Sedov <li><a href="index.html"><span>Main Page</span></a></li> 16ae771770SStanislav Sedov <li><a href="pages.html"><span>Related Pages</span></a></li> 17ae771770SStanislav Sedov <li><a href="modules.html"><span>Modules</span></a></li> 18ae771770SStanislav Sedov <li><a href="annotated.html"><span>Data Structures</span></a></li> 19ae771770SStanislav Sedov </ul> 20ae771770SStanislav Sedov </div> 21ae771770SStanislav Sedov</div> 22ae771770SStanislav Sedov<div class="contents"> 23ae771770SStanislav Sedov<h1>Heimdal Kerberos 5 error reporting functions</h1><table border="0" cellpadding="0" cellspacing="0"> 24ae771770SStanislav Sedov<tr><td></td></tr> 25ae771770SStanislav Sedov<tr><td colspan="2"><br><h2>Functions</h2></td></tr> 26ae771770SStanislav Sedov<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br> 27ae771770SStanislav Sedovkrb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#gbfadc71c9680807445c9c73bfb80c7de">krb5_eai_to_heim_errno</a> (int eai_errno, int system_error)</td></tr> 28ae771770SStanislav Sedov 29ae771770SStanislav Sedov<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br> 30ae771770SStanislav Sedovkrb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#gf04d419f89c5d4525f05f08710aed85e">krb5_h_errno_to_heim_errno</a> (int eai_errno)</td></tr> 31ae771770SStanislav Sedov 32ae771770SStanislav Sedov<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION void <br> 33ae771770SStanislav SedovKRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#g21bbb3fd831bce0e987b1184668e0764">krb5_clear_error_message</a> (krb5_context context)</td></tr> 34ae771770SStanislav Sedov 35ae771770SStanislav Sedov<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION void <br> 36ae771770SStanislav SedovKRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#g8961540f386e3e3d2700d31f7a4ba63d">krb5_set_error_message</a> (krb5_context context, krb5_error_code ret, const char *fmt,...) __attribute__((format(printf</td></tr> 37ae771770SStanislav Sedov 38ae771770SStanislav Sedov<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br> 39ae771770SStanislav Sedovkrb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#g0561875954862c00e141a9e680f2e8d0">krb5_vwarn</a> (krb5_context context, krb5_error_code code, const char *fmt, va_list ap) __attribute__((format(printf</td></tr> 40ae771770SStanislav Sedov 41ae771770SStanislav Sedov</table> 42ae771770SStanislav Sedov<hr><a name="_details"></a><h2>Detailed Description</h2> 43ae771770SStanislav Sedov<hr><h2>Function Documentation</h2> 44ae771770SStanislav Sedov<a class="anchor" name="g21bbb3fd831bce0e987b1184668e0764"></a><!-- doxytag: member="error_string.c::krb5_clear_error_message" ref="g21bbb3fd831bce0e987b1184668e0764" args="(krb5_context context)" --> 45ae771770SStanislav Sedov<div class="memitem"> 46ae771770SStanislav Sedov<div class="memproto"> 47ae771770SStanislav Sedov <table class="memname"> 48ae771770SStanislav Sedov <tr> 49ae771770SStanislav Sedov <td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_clear_error_message </td> 50ae771770SStanislav Sedov <td>(</td> 51ae771770SStanislav Sedov <td class="paramtype">krb5_context </td> 52ae771770SStanislav Sedov <td class="paramname"> <em>context</em> </td> 53ae771770SStanislav Sedov <td> ) </td> 54ae771770SStanislav Sedov <td></td> 55ae771770SStanislav Sedov </tr> 56ae771770SStanislav Sedov </table> 57ae771770SStanislav Sedov</div> 58ae771770SStanislav Sedov<div class="memdoc"> 59ae771770SStanislav Sedov 60ae771770SStanislav Sedov<p> 61ae771770SStanislav SedovClears the error message from the Kerberos 5 context.<p> 62ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd> 63ae771770SStanislav Sedov <table border="0" cellspacing="2" cellpadding="0"> 64ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>The Kerberos 5 context to clear </td></tr> 65ae771770SStanislav Sedov </table> 66ae771770SStanislav Sedov</dl> 67ae771770SStanislav Sedov 68ae771770SStanislav Sedov</div> 69ae771770SStanislav Sedov</div><p> 70ae771770SStanislav Sedov<a class="anchor" name="gbfadc71c9680807445c9c73bfb80c7de"></a><!-- doxytag: member="eai_to_heim_errno.c::krb5_eai_to_heim_errno" ref="gbfadc71c9680807445c9c73bfb80c7de" args="(int eai_errno, int system_error)" --> 71ae771770SStanislav Sedov<div class="memitem"> 72ae771770SStanislav Sedov<div class="memproto"> 73ae771770SStanislav Sedov <table class="memname"> 74ae771770SStanislav Sedov <tr> 75ae771770SStanislav Sedov <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_eai_to_heim_errno </td> 76ae771770SStanislav Sedov <td>(</td> 77ae771770SStanislav Sedov <td class="paramtype">int </td> 78ae771770SStanislav Sedov <td class="paramname"> <em>eai_errno</em>, </td> 79ae771770SStanislav Sedov </tr> 80ae771770SStanislav Sedov <tr> 81ae771770SStanislav Sedov <td class="paramkey"></td> 82ae771770SStanislav Sedov <td></td> 83ae771770SStanislav Sedov <td class="paramtype">int </td> 84ae771770SStanislav Sedov <td class="paramname"> <em>system_error</em></td><td> </td> 85ae771770SStanislav Sedov </tr> 86ae771770SStanislav Sedov <tr> 87ae771770SStanislav Sedov <td></td> 88ae771770SStanislav Sedov <td>)</td> 89ae771770SStanislav Sedov <td></td><td></td><td></td> 90ae771770SStanislav Sedov </tr> 91ae771770SStanislav Sedov </table> 92ae771770SStanislav Sedov</div> 93ae771770SStanislav Sedov<div class="memdoc"> 94ae771770SStanislav Sedov 95ae771770SStanislav Sedov<p> 96ae771770SStanislav SedovConvert the getaddrinfo() error code to a Kerberos et error code.<p> 97ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd> 98ae771770SStanislav Sedov <table border="0" cellspacing="2" cellpadding="0"> 99ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>eai_errno</em> </td><td>contains the error code from getaddrinfo(). </td></tr> 100ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>system_error</em> </td><td>should have the value of errno after the failed getaddrinfo().</td></tr> 101ae771770SStanislav Sedov </table> 102ae771770SStanislav Sedov</dl> 103ae771770SStanislav Sedov<dl class="return" compact><dt><b>Returns:</b></dt><dd>Kerberos error code representing the EAI errors. </dd></dl> 104ae771770SStanislav Sedov 105ae771770SStanislav Sedov</div> 106ae771770SStanislav Sedov</div><p> 107ae771770SStanislav Sedov<a class="anchor" name="gf04d419f89c5d4525f05f08710aed85e"></a><!-- doxytag: member="eai_to_heim_errno.c::krb5_h_errno_to_heim_errno" ref="gf04d419f89c5d4525f05f08710aed85e" args="(int eai_errno)" --> 108ae771770SStanislav Sedov<div class="memitem"> 109ae771770SStanislav Sedov<div class="memproto"> 110ae771770SStanislav Sedov <table class="memname"> 111ae771770SStanislav Sedov <tr> 112ae771770SStanislav Sedov <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_h_errno_to_heim_errno </td> 113ae771770SStanislav Sedov <td>(</td> 114ae771770SStanislav Sedov <td class="paramtype">int </td> 115ae771770SStanislav Sedov <td class="paramname"> <em>eai_errno</em> </td> 116ae771770SStanislav Sedov <td> ) </td> 117ae771770SStanislav Sedov <td></td> 118ae771770SStanislav Sedov </tr> 119ae771770SStanislav Sedov </table> 120ae771770SStanislav Sedov</div> 121ae771770SStanislav Sedov<div class="memdoc"> 122ae771770SStanislav Sedov 123ae771770SStanislav Sedov<p> 124ae771770SStanislav SedovConvert the gethostname() error code (h_error) to a Kerberos et error code.<p> 125ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd> 126ae771770SStanislav Sedov <table border="0" cellspacing="2" cellpadding="0"> 127ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>eai_errno</em> </td><td>contains the error code from gethostname().</td></tr> 128ae771770SStanislav Sedov </table> 129ae771770SStanislav Sedov</dl> 130ae771770SStanislav Sedov<dl class="return" compact><dt><b>Returns:</b></dt><dd>Kerberos error code representing the gethostname errors. </dd></dl> 131ae771770SStanislav Sedov 132ae771770SStanislav Sedov</div> 133ae771770SStanislav Sedov</div><p> 134ae771770SStanislav Sedov<a class="anchor" name="g8961540f386e3e3d2700d31f7a4ba63d"></a><!-- doxytag: member="error_string.c::krb5_set_error_message" ref="g8961540f386e3e3d2700d31f7a4ba63d" args="(krb5_context context, krb5_error_code ret, const char *fmt,...) __attribute__((format(printf" --> 135ae771770SStanislav Sedov<div class="memitem"> 136ae771770SStanislav Sedov<div class="memproto"> 137ae771770SStanislav Sedov <table class="memname"> 138ae771770SStanislav Sedov <tr> 139ae771770SStanislav Sedov <td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_error_message </td> 140ae771770SStanislav Sedov <td>(</td> 141ae771770SStanislav Sedov <td class="paramtype">krb5_context </td> 142ae771770SStanislav Sedov <td class="paramname"> <em>context</em>, </td> 143ae771770SStanislav Sedov </tr> 144ae771770SStanislav Sedov <tr> 145ae771770SStanislav Sedov <td class="paramkey"></td> 146ae771770SStanislav Sedov <td></td> 147ae771770SStanislav Sedov <td class="paramtype">krb5_error_code </td> 148ae771770SStanislav Sedov <td class="paramname"> <em>ret</em>, </td> 149ae771770SStanislav Sedov </tr> 150ae771770SStanislav Sedov <tr> 151ae771770SStanislav Sedov <td class="paramkey"></td> 152ae771770SStanislav Sedov <td></td> 153ae771770SStanislav Sedov <td class="paramtype">const char * </td> 154ae771770SStanislav Sedov <td class="paramname"> <em>fmt</em>, </td> 155ae771770SStanislav Sedov </tr> 156ae771770SStanislav Sedov <tr> 157ae771770SStanislav Sedov <td class="paramkey"></td> 158ae771770SStanislav Sedov <td></td> 159ae771770SStanislav Sedov <td class="paramtype"> </td> 160ae771770SStanislav Sedov <td class="paramname"> <em>...</em></td><td> </td> 161ae771770SStanislav Sedov </tr> 162ae771770SStanislav Sedov <tr> 163ae771770SStanislav Sedov <td></td> 164ae771770SStanislav Sedov <td>)</td> 165ae771770SStanislav Sedov <td></td><td></td><td></td> 166ae771770SStanislav Sedov </tr> 167ae771770SStanislav Sedov </table> 168ae771770SStanislav Sedov</div> 169ae771770SStanislav Sedov<div class="memdoc"> 170ae771770SStanislav Sedov 171ae771770SStanislav Sedov<p> 172ae771770SStanislav SedovSet the context full error string for a specific error code. The error that is stored should be internationalized.<p> 173ae771770SStanislav SedovThe if context is NULL, no error string is stored.<p> 174ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd> 175ae771770SStanislav Sedov <table border="0" cellspacing="2" cellpadding="0"> 176ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>Kerberos 5 context </td></tr> 177ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>ret</em> </td><td>The error code </td></tr> 178ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>fmt</em> </td><td>Error string for the error code </td></tr> 179ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>...</em> </td><td>printf(3) style parameters. </td></tr> 180ae771770SStanislav Sedov </table> 181ae771770SStanislav Sedov</dl> 182ae771770SStanislav Sedov 183ae771770SStanislav Sedov</div> 184ae771770SStanislav Sedov</div><p> 185ae771770SStanislav Sedov<a class="anchor" name="g0561875954862c00e141a9e680f2e8d0"></a><!-- doxytag: member="warn.c::krb5_vwarn" ref="g0561875954862c00e141a9e680f2e8d0" args="(krb5_context context, krb5_error_code code, const char *fmt, va_list ap) __attribute__((format(printf" --> 186ae771770SStanislav Sedov<div class="memitem"> 187ae771770SStanislav Sedov<div class="memproto"> 188ae771770SStanislav Sedov <table class="memname"> 189ae771770SStanislav Sedov <tr> 190ae771770SStanislav Sedov <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_vwarn </td> 191ae771770SStanislav Sedov <td>(</td> 192ae771770SStanislav Sedov <td class="paramtype">krb5_context </td> 193ae771770SStanislav Sedov <td class="paramname"> <em>context</em>, </td> 194ae771770SStanislav Sedov </tr> 195ae771770SStanislav Sedov <tr> 196ae771770SStanislav Sedov <td class="paramkey"></td> 197ae771770SStanislav Sedov <td></td> 198ae771770SStanislav Sedov <td class="paramtype">krb5_error_code </td> 199ae771770SStanislav Sedov <td class="paramname"> <em>code</em>, </td> 200ae771770SStanislav Sedov </tr> 201ae771770SStanislav Sedov <tr> 202ae771770SStanislav Sedov <td class="paramkey"></td> 203ae771770SStanislav Sedov <td></td> 204ae771770SStanislav Sedov <td class="paramtype">const char * </td> 205ae771770SStanislav Sedov <td class="paramname"> <em>fmt</em>, </td> 206ae771770SStanislav Sedov </tr> 207ae771770SStanislav Sedov <tr> 208ae771770SStanislav Sedov <td class="paramkey"></td> 209ae771770SStanislav Sedov <td></td> 210ae771770SStanislav Sedov <td class="paramtype">va_list </td> 211ae771770SStanislav Sedov <td class="paramname"> <em>ap</em></td><td> </td> 212ae771770SStanislav Sedov </tr> 213ae771770SStanislav Sedov <tr> 214ae771770SStanislav Sedov <td></td> 215ae771770SStanislav Sedov <td>)</td> 216ae771770SStanislav Sedov <td></td><td></td><td></td> 217ae771770SStanislav Sedov </tr> 218ae771770SStanislav Sedov </table> 219ae771770SStanislav Sedov</div> 220ae771770SStanislav Sedov<div class="memdoc"> 221ae771770SStanislav Sedov 222ae771770SStanislav Sedov<p> 223ae771770SStanislav SedovLog a warning to the log, default stderr, include the error from the last failure.<p> 224ae771770SStanislav Sedov<dl compact><dt><b>Parameters:</b></dt><dd> 225ae771770SStanislav Sedov <table border="0" cellspacing="2" cellpadding="0"> 226ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>A Kerberos 5 context. </td></tr> 227ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>error code of the last error </td></tr> 228ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>fmt</em> </td><td>message to print </td></tr> 229ae771770SStanislav Sedov <tr><td valign="top"></td><td valign="top"><em>ap</em> </td><td>arguments </td></tr> 230ae771770SStanislav Sedov </table> 231ae771770SStanislav Sedov</dl> 232ae771770SStanislav Sedov 233ae771770SStanislav Sedov</div> 234ae771770SStanislav Sedov</div><p> 235ae771770SStanislav Sedov</div> 236ae771770SStanislav Sedov<hr size="1"><address style="text-align: right;"><small> 237*cf771f22SStanislav SedovGenerated on Wed Jan 11 14:07:49 2012 for HeimdalKerberos5library by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address> 238ae771770SStanislav Sedov</body> 239ae771770SStanislav Sedov</html> 240
