crypto/heimdal/doc/doxyout/krb5/html/group__krb5__error.html

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