1226031Sstas<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2226031Sstas<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 3226031Sstas<title>HeimdalKerberos5library: Heimdal Kerberos 5 error reporting functions</title> 4226031Sstas<link href="doxygen.css" rel="stylesheet" type="text/css"> 5226031Sstas<link href="tabs.css" rel="stylesheet" type="text/css"> 6226031Sstas</head><body> 7226031Sstas<p> 8226031Sstas<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a> 9226031Sstas</p> 10226031Sstas<!-- end of header marker --> 11226031Sstas<!-- Generated by Doxygen 1.5.6 --> 12226031Sstas<div class="navigation" id="top"> 13226031Sstas <div class="tabs"> 14226031Sstas <ul> 15226031Sstas <li><a href="index.html"><span>Main Page</span></a></li> 16226031Sstas <li><a href="pages.html"><span>Related Pages</span></a></li> 17226031Sstas <li><a href="modules.html"><span>Modules</span></a></li> 18226031Sstas <li><a href="annotated.html"><span>Data Structures</span></a></li> 19226031Sstas </ul> 20226031Sstas </div> 21226031Sstas</div> 22226031Sstas<div class="contents"> 23226031Sstas<h1>Heimdal Kerberos 5 error reporting functions</h1><table border="0" cellpadding="0" cellspacing="0"> 24226031Sstas<tr><td></td></tr> 25226031Sstas<tr><td colspan="2"><br><h2>Functions</h2></td></tr> 26226031Sstas<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br> 27226031Sstaskrb5_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> 28226031Sstas 29226031Sstas<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br> 30226031Sstaskrb5_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> 31226031Sstas 32226031Sstas<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION void <br> 33226031SstasKRB5_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> 34226031Sstas 35226031Sstas<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION void <br> 36226031SstasKRB5_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> 37226031Sstas 38226031Sstas<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br> 39226031Sstaskrb5_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> 40226031Sstas 41226031Sstas</table> 42226031Sstas<hr><a name="_details"></a><h2>Detailed Description</h2> 43226031Sstas<hr><h2>Function Documentation</h2> 44226031Sstas<a class="anchor" name="g21bbb3fd831bce0e987b1184668e0764"></a><!-- doxytag: member="error_string.c::krb5_clear_error_message" ref="g21bbb3fd831bce0e987b1184668e0764" args="(krb5_context context)" --> 45226031Sstas<div class="memitem"> 46226031Sstas<div class="memproto"> 47226031Sstas <table class="memname"> 48226031Sstas <tr> 49226031Sstas <td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_clear_error_message </td> 50226031Sstas <td>(</td> 51226031Sstas <td class="paramtype">krb5_context </td> 52226031Sstas <td class="paramname"> <em>context</em> </td> 53226031Sstas <td> ) </td> 54226031Sstas <td></td> 55226031Sstas </tr> 56226031Sstas </table> 57226031Sstas</div> 58226031Sstas<div class="memdoc"> 59226031Sstas 60226031Sstas<p> 61226031SstasClears the error message from the Kerberos 5 context.<p> 62226031Sstas<dl compact><dt><b>Parameters:</b></dt><dd> 63226031Sstas <table border="0" cellspacing="2" cellpadding="0"> 64226031Sstas <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>The Kerberos 5 context to clear </td></tr> 65226031Sstas </table> 66226031Sstas</dl> 67226031Sstas 68226031Sstas</div> 69226031Sstas</div><p> 70226031Sstas<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)" --> 71226031Sstas<div class="memitem"> 72226031Sstas<div class="memproto"> 73226031Sstas <table class="memname"> 74226031Sstas <tr> 75226031Sstas <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_eai_to_heim_errno </td> 76226031Sstas <td>(</td> 77226031Sstas <td class="paramtype">int </td> 78226031Sstas <td class="paramname"> <em>eai_errno</em>, </td> 79226031Sstas </tr> 80226031Sstas <tr> 81226031Sstas <td class="paramkey"></td> 82226031Sstas <td></td> 83226031Sstas <td class="paramtype">int </td> 84226031Sstas <td class="paramname"> <em>system_error</em></td><td> </td> 85226031Sstas </tr> 86226031Sstas <tr> 87226031Sstas <td></td> 88226031Sstas <td>)</td> 89226031Sstas <td></td><td></td><td></td> 90226031Sstas </tr> 91226031Sstas </table> 92226031Sstas</div> 93226031Sstas<div class="memdoc"> 94226031Sstas 95226031Sstas<p> 96226031SstasConvert the getaddrinfo() error code to a Kerberos et error code.<p> 97226031Sstas<dl compact><dt><b>Parameters:</b></dt><dd> 98226031Sstas <table border="0" cellspacing="2" cellpadding="0"> 99226031Sstas <tr><td valign="top"></td><td valign="top"><em>eai_errno</em> </td><td>contains the error code from getaddrinfo(). </td></tr> 100226031Sstas <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> 101226031Sstas </table> 102226031Sstas</dl> 103226031Sstas<dl class="return" compact><dt><b>Returns:</b></dt><dd>Kerberos error code representing the EAI errors. </dd></dl> 104226031Sstas 105226031Sstas</div> 106226031Sstas</div><p> 107226031Sstas<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)" --> 108226031Sstas<div class="memitem"> 109226031Sstas<div class="memproto"> 110226031Sstas <table class="memname"> 111226031Sstas <tr> 112226031Sstas <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_h_errno_to_heim_errno </td> 113226031Sstas <td>(</td> 114226031Sstas <td class="paramtype">int </td> 115226031Sstas <td class="paramname"> <em>eai_errno</em> </td> 116226031Sstas <td> ) </td> 117226031Sstas <td></td> 118226031Sstas </tr> 119226031Sstas </table> 120226031Sstas</div> 121226031Sstas<div class="memdoc"> 122226031Sstas 123226031Sstas<p> 124226031SstasConvert the gethostname() error code (h_error) to a Kerberos et error code.<p> 125226031Sstas<dl compact><dt><b>Parameters:</b></dt><dd> 126226031Sstas <table border="0" cellspacing="2" cellpadding="0"> 127226031Sstas <tr><td valign="top"></td><td valign="top"><em>eai_errno</em> </td><td>contains the error code from gethostname().</td></tr> 128226031Sstas </table> 129226031Sstas</dl> 130226031Sstas<dl class="return" compact><dt><b>Returns:</b></dt><dd>Kerberos error code representing the gethostname errors. </dd></dl> 131226031Sstas 132226031Sstas</div> 133226031Sstas</div><p> 134226031Sstas<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" --> 135226031Sstas<div class="memitem"> 136226031Sstas<div class="memproto"> 137226031Sstas <table class="memname"> 138226031Sstas <tr> 139226031Sstas <td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_error_message </td> 140226031Sstas <td>(</td> 141226031Sstas <td class="paramtype">krb5_context </td> 142226031Sstas <td class="paramname"> <em>context</em>, </td> 143226031Sstas </tr> 144226031Sstas <tr> 145226031Sstas <td class="paramkey"></td> 146226031Sstas <td></td> 147226031Sstas <td class="paramtype">krb5_error_code </td> 148226031Sstas <td class="paramname"> <em>ret</em>, </td> 149226031Sstas </tr> 150226031Sstas <tr> 151226031Sstas <td class="paramkey"></td> 152226031Sstas <td></td> 153226031Sstas <td class="paramtype">const char * </td> 154226031Sstas <td class="paramname"> <em>fmt</em>, </td> 155226031Sstas </tr> 156226031Sstas <tr> 157226031Sstas <td class="paramkey"></td> 158226031Sstas <td></td> 159226031Sstas <td class="paramtype"> </td> 160226031Sstas <td class="paramname"> <em>...</em></td><td> </td> 161226031Sstas </tr> 162226031Sstas <tr> 163226031Sstas <td></td> 164226031Sstas <td>)</td> 165226031Sstas <td></td><td></td><td></td> 166226031Sstas </tr> 167226031Sstas </table> 168226031Sstas</div> 169226031Sstas<div class="memdoc"> 170226031Sstas 171226031Sstas<p> 172226031SstasSet the context full error string for a specific error code. The error that is stored should be internationalized.<p> 173226031SstasThe if context is NULL, no error string is stored.<p> 174226031Sstas<dl compact><dt><b>Parameters:</b></dt><dd> 175226031Sstas <table border="0" cellspacing="2" cellpadding="0"> 176226031Sstas <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>Kerberos 5 context </td></tr> 177226031Sstas <tr><td valign="top"></td><td valign="top"><em>ret</em> </td><td>The error code </td></tr> 178226031Sstas <tr><td valign="top"></td><td valign="top"><em>fmt</em> </td><td>Error string for the error code </td></tr> 179226031Sstas <tr><td valign="top"></td><td valign="top"><em>...</em> </td><td>printf(3) style parameters. </td></tr> 180226031Sstas </table> 181226031Sstas</dl> 182226031Sstas 183226031Sstas</div> 184226031Sstas</div><p> 185226031Sstas<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" --> 186226031Sstas<div class="memitem"> 187226031Sstas<div class="memproto"> 188226031Sstas <table class="memname"> 189226031Sstas <tr> 190226031Sstas <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_vwarn </td> 191226031Sstas <td>(</td> 192226031Sstas <td class="paramtype">krb5_context </td> 193226031Sstas <td class="paramname"> <em>context</em>, </td> 194226031Sstas </tr> 195226031Sstas <tr> 196226031Sstas <td class="paramkey"></td> 197226031Sstas <td></td> 198226031Sstas <td class="paramtype">krb5_error_code </td> 199226031Sstas <td class="paramname"> <em>code</em>, </td> 200226031Sstas </tr> 201226031Sstas <tr> 202226031Sstas <td class="paramkey"></td> 203226031Sstas <td></td> 204226031Sstas <td class="paramtype">const char * </td> 205226031Sstas <td class="paramname"> <em>fmt</em>, </td> 206226031Sstas </tr> 207226031Sstas <tr> 208226031Sstas <td class="paramkey"></td> 209226031Sstas <td></td> 210226031Sstas <td class="paramtype">va_list </td> 211226031Sstas <td class="paramname"> <em>ap</em></td><td> </td> 212226031Sstas </tr> 213226031Sstas <tr> 214226031Sstas <td></td> 215226031Sstas <td>)</td> 216226031Sstas <td></td><td></td><td></td> 217226031Sstas </tr> 218226031Sstas </table> 219226031Sstas</div> 220226031Sstas<div class="memdoc"> 221226031Sstas 222226031Sstas<p> 223226031SstasLog a warning to the log, default stderr, include the error from the last failure.<p> 224226031Sstas<dl compact><dt><b>Parameters:</b></dt><dd> 225226031Sstas <table border="0" cellspacing="2" cellpadding="0"> 226226031Sstas <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>A Kerberos 5 context. </td></tr> 227226031Sstas <tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>error code of the last error </td></tr> 228226031Sstas <tr><td valign="top"></td><td valign="top"><em>fmt</em> </td><td>message to print </td></tr> 229226031Sstas <tr><td valign="top"></td><td valign="top"><em>ap</em> </td><td>arguments </td></tr> 230226031Sstas </table> 231226031Sstas</dl> 232226031Sstas 233226031Sstas</div> 234226031Sstas</div><p> 235226031Sstas</div> 236226031Sstas<hr size="1"><address style="text-align: right;"><small> 237234027SstasGenerated 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> 238226031Sstas</body> 239226031Sstas</html> 240
