diff options
| author | Hiroki Sato <hrs@FreeBSD.org> | 2018-04-04 04:21:19 +0000 |
|---|---|---|
| committer | Hiroki Sato <hrs@FreeBSD.org> | 2018-04-04 04:21:19 +0000 |
| commit | d684f11da759490a8d98d7b790796106285f4084 (patch) | |
| tree | 27b7356df710fdf1440fe2c23154b8121e99f2ab /doc/doxyout/krb5/html/group__krb5__error.html | |
| parent | f52d4664e3f68828c06f85bfc1afa271e3e04713 (diff) | |
Notes
Diffstat (limited to 'doc/doxyout/krb5/html/group__krb5__error.html')
| -rw-r--r-- | doc/doxyout/krb5/html/group__krb5__error.html | 1009 |
1 files changed, 896 insertions, 113 deletions
diff --git a/doc/doxyout/krb5/html/group__krb5__error.html b/doc/doxyout/krb5/html/group__krb5__error.html index dc87eadb3284..38ee265277ac 100644 --- a/doc/doxyout/krb5/html/group__krb5__error.html +++ b/doc/doxyout/krb5/html/group__krb5__error.html @@ -1,6 +1,6 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> -<title>HeimdalKerberos5library: Heimdal Kerberos 5 error reporting functions</title> +<title>Heimdal Kerberos 5 error reporting functions</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> @@ -8,232 +8,1015 @@ <a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a> </p> <!-- end of header marker --> -<!-- Generated by Doxygen 1.5.6 --> -<div class="navigation" id="top"> - <div class="tabs"> - <ul> - <li><a href="index.html"><span>Main Page</span></a></li> - <li><a href="pages.html"><span>Related Pages</span></a></li> - <li><a href="modules.html"><span>Modules</span></a></li> - <li><a href="annotated.html"><span>Data Structures</span></a></li> - </ul> - </div> -</div> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',false,false,'search.php','Search'); +}); +</script> +<div id="main-nav"></div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">Heimdal Kerberos 5 error reporting functions</div> </div> +</div><!--header--> <div class="contents"> -<h1>Heimdal Kerberos 5 error reporting functions</h1><table border="0" cellpadding="0" cellspacing="0"> -<tr><td></td></tr> -<tr><td colspan="2"><br><h2>Functions</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br> -krb5_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> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:ga785866fad6a16f78e398220bea3c079e"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION char *KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#ga785866fad6a16f78e398220bea3c079e">krb5_get_error_string</a> (krb5_context context) KRB5_DEPRECATED_FUNCTION("Use <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message</a> instead")</td></tr> +<tr class="separator:ga785866fad6a16f78e398220bea3c079e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabfadc71c9680807445c9c73bfb80c7de"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#gabfadc71c9680807445c9c73bfb80c7de">krb5_eai_to_heim_errno</a> (int eai_errno, int system_error)</td></tr> +<tr class="separator:gabfadc71c9680807445c9c73bfb80c7de"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf04d419f89c5d4525f05f08710aed85e"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#gaf04d419f89c5d4525f05f08710aed85e">krb5_h_errno_to_heim_errno</a> (int eai_errno)</td></tr> +<tr class="separator:gaf04d419f89c5d4525f05f08710aed85e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga21bbb3fd831bce0e987b1184668e0764"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION void KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#ga21bbb3fd831bce0e987b1184668e0764">krb5_clear_error_message</a> (krb5_context context)</td></tr> +<tr class="separator:ga21bbb3fd831bce0e987b1184668e0764"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0640bed1721367716746fb6cc6bf56dd"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION void KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#ga0640bed1721367716746fb6cc6bf56dd">krb5_set_error_message</a> (krb5_context context, krb5_error_code ret, const char *fmt,...) __attribute__((__format__(__printf__</td></tr> +<tr class="separator:ga0640bed1721367716746fb6cc6bf56dd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga19a03dbcbff7cc04e3756ac7a9f14385"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION void KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#ga19a03dbcbff7cc04e3756ac7a9f14385">krb5_vset_error_message</a> (krb5_context context, krb5_error_code ret, const char *fmt, va_list args) __attribute__((__format__(__printf__</td></tr> +<tr class="separator:ga19a03dbcbff7cc04e3756ac7a9f14385"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf106c9897306a7d9b5cd10c467d6e382"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION void KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#gaf106c9897306a7d9b5cd10c467d6e382">krb5_vprepend_error_message</a> (krb5_context context, krb5_error_code ret, const char *fmt, va_list args) __attribute__((__format__(__printf__</td></tr> +<tr class="separator:gaf106c9897306a7d9b5cd10c467d6e382"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga35cbf80e68f43a6d9503952886b85ed2"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION const char *KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message</a> (krb5_context context, krb5_error_code code)</td></tr> +<tr class="separator:ga35cbf80e68f43a6d9503952886b85ed2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaaf6afd30b2a89fe2e9a4ace03626921e"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION void KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#gaaf6afd30b2a89fe2e9a4ace03626921e">krb5_free_error_message</a> (krb5_context context, const char *msg)</td></tr> +<tr class="separator:gaaf6afd30b2a89fe2e9a4ace03626921e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaab4d0325ff2a30fbd670d6e96c68b8ec"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#gaab4d0325ff2a30fbd670d6e96c68b8ec">krb5_vwarn</a> (krb5_context context, krb5_error_code code, const char *fmt, va_list ap) __attribute__((__format__(__printf__</td></tr> +<tr class="separator:gaab4d0325ff2a30fbd670d6e96c68b8ec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac25b2bfae99043329f1d9eb38c63cbe5"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#gac25b2bfae99043329f1d9eb38c63cbe5">krb5_warn</a> (krb5_context context, krb5_error_code code, const char *fmt,...) __attribute__((__format__(__printf__</td></tr> +<tr class="separator:gac25b2bfae99043329f1d9eb38c63cbe5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac1c13284b5c34f1f207423693ec7fdae"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#gac1c13284b5c34f1f207423693ec7fdae">krb5_vwarnx</a> (krb5_context context, const char *fmt, va_list ap) __attribute__((__format__(__printf__</td></tr> +<tr class="separator:gac1c13284b5c34f1f207423693ec7fdae"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafa3c8de06d8bc7205ff1ec9c379d2cb3"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#gafa3c8de06d8bc7205ff1ec9c379d2cb3">krb5_warnx</a> (krb5_context context, const char *fmt,...) __attribute__((__format__(__printf__</td></tr> +<tr class="separator:gafa3c8de06d8bc7205ff1ec9c379d2cb3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gadbae318ed4838e81566c36b545db7b35"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#gadbae318ed4838e81566c36b545db7b35">krb5_verr</a> (krb5_context context, int eval, krb5_error_code code, const char *fmt, va_list ap) __attribute__((__noreturn__</td></tr> +<tr class="separator:gadbae318ed4838e81566c36b545db7b35"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad75c268bcf26225ee8d4a39c178131a1"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#gad75c268bcf26225ee8d4a39c178131a1">krb5_err</a> (krb5_context context, int eval, krb5_error_code code, const char *fmt,...) __attribute__((__noreturn__</td></tr> +<tr class="separator:gad75c268bcf26225ee8d4a39c178131a1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa908a3716343e49cf0b9dd681b018700"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#gaa908a3716343e49cf0b9dd681b018700">krb5_verrx</a> (krb5_context context, int eval, const char *fmt, va_list ap) __attribute__((__noreturn__</td></tr> +<tr class="separator:gaa908a3716343e49cf0b9dd681b018700"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1b898cb64c7e0e9a61d52440e1ada17e"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#ga1b898cb64c7e0e9a61d52440e1ada17e">krb5_errx</a> (krb5_context context, int eval, const char *fmt,...) __attribute__((__noreturn__</td></tr> +<tr class="separator:ga1b898cb64c7e0e9a61d52440e1ada17e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaefd5e28eb27e811b3d76850d69f680da"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#gaefd5e28eb27e811b3d76850d69f680da">krb5_vabort</a> (krb5_context context, krb5_error_code code, const char *fmt, va_list ap) __attribute__((__noreturn__</td></tr> +<tr class="separator:gaefd5e28eb27e811b3d76850d69f680da"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga11632525baa077050131a4c6a935e9f4"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#ga11632525baa077050131a4c6a935e9f4">krb5_abort</a> (krb5_context context, krb5_error_code code, const char *fmt,...) __attribute__((__noreturn__</td></tr> +<tr class="separator:ga11632525baa077050131a4c6a935e9f4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae6fc9753a685ce4a30f719bb4c80aa0d"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#gae6fc9753a685ce4a30f719bb4c80aa0d">krb5_abortx</a> (krb5_context context, const char *fmt,...) __attribute__((__noreturn__</td></tr> +<tr class="separator:gae6fc9753a685ce4a30f719bb4c80aa0d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac3e03d80523f1f848d7d1f8b170dd8f9"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#gac3e03d80523f1f848d7d1f8b170dd8f9">krb5_set_warn_dest</a> (krb5_context context, krb5_log_facility *fac)</td></tr> +<tr class="separator:gac3e03d80523f1f848d7d1f8b170dd8f9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga41e3138a66264a087ec916d0d5704ff9"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_log_facility *KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__error.html#ga41e3138a66264a087ec916d0d5704ff9">krb5_get_warn_dest</a> (krb5_context context)</td></tr> +<tr class="separator:ga41e3138a66264a087ec916d0d5704ff9"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<h2 class="groupheader">Function Documentation</h2> +<a id="ga11632525baa077050131a4c6a935e9f4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga11632525baa077050131a4c6a935e9f4">◆ </a></span>krb5_abort()</h2> -<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br> -krb5_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> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_abort </td> + <td>(</td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">krb5_error_code </td> + <td class="paramname"><em>code</em>, </td> + </tr> + <tr> + <td class="paramkey"></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>Log a warning to the log, default stderr, include the error from the last failure and then abort.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>A Kerberos 5 context </td></tr> + <tr><td class="paramname">code</td><td>error code of the last error </td></tr> + <tr><td class="paramname">fmt</td><td>message to print </td></tr> + <tr><td class="paramname">...</td><td>arguments for format string </td></tr> + </table> + </dd> +</dl> -<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION void <br> -KRB5_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> +</div> +</div> +<a id="gae6fc9753a685ce4a30f719bb4c80aa0d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae6fc9753a685ce4a30f719bb4c80aa0d">◆ </a></span>krb5_abortx()</h2> -<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION void <br> -KRB5_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> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_abortx </td> + <td>(</td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></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>Log a warning to the log, default stderr, and then abort.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>A Kerberos 5 context </td></tr> + <tr><td class="paramname">fmt</td><td>printf format string of message to print </td></tr> + <tr><td class="paramname">...</td><td>arguments for format string </td></tr> + </table> + </dd> +</dl> -<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br> -krb5_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> +</div> +</div> +<a id="ga21bbb3fd831bce0e987b1184668e0764"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga21bbb3fd831bce0e987b1184668e0764">◆ </a></span>krb5_clear_error_message()</h2> -</table> -<hr><a name="_details"></a><h2>Detailed Description</h2> -<hr><h2>Function Documentation</h2> -<a class="anchor" name="g21bbb3fd831bce0e987b1184668e0764"></a><!-- doxytag: member="error_string.c::krb5_clear_error_message" ref="g21bbb3fd831bce0e987b1184668e0764" args="(krb5_context context)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_clear_error_message </td> + <td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_clear_error_message </td> <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"> <em>context</em> </td> - <td> ) </td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em></td><td>)</td> <td></td> </tr> </table> +</div><div class="memdoc"> +<p>Clears the error message from the Kerberos 5 context.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>The Kerberos 5 context to clear </td></tr> + </table> + </dd> +</dl> + +</div> </div> -<div class="memdoc"> +<a id="gabfadc71c9680807445c9c73bfb80c7de"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gabfadc71c9680807445c9c73bfb80c7de">◆ </a></span>krb5_eai_to_heim_errno()</h2> -<p> -Clears the error message from the Kerberos 5 context.<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>The Kerberos 5 context to clear </td></tr> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_eai_to_heim_errno </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>eai_errno</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>system_error</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Convert the getaddrinfo() error code to a Kerberos et error code.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">eai_errno</td><td>contains the error code from getaddrinfo(). </td></tr> + <tr><td class="paramname">system_error</td><td>should have the value of errno after the failed getaddrinfo().</td></tr> </table> + </dd> </dl> +<dl class="section return"><dt>Returns</dt><dd>Kerberos error code representing the EAI errors. </dd></dl> </div> -</div><p> -<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)" --> +</div> +<a id="gad75c268bcf26225ee8d4a39c178131a1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad75c268bcf26225ee8d4a39c178131a1">◆ </a></span>krb5_err()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_eai_to_heim_errno </td> + <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_err </td> <td>(</td> - <td class="paramtype">int </td> - <td class="paramname"> <em>eai_errno</em>, </td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>eval</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">int </td> - <td class="paramname"> <em>system_error</em></td><td> </td> + <td class="paramtype">krb5_error_code </td> + <td class="paramname"><em>code</em>, </td> + </tr> + <tr> + <td class="paramkey"></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><td></td> + <td></td><td></td> </tr> </table> +</div><div class="memdoc"> +<p>Log a warning to the log, default stderr, include bthe error from the last failure and then exit.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>A Kerberos 5 context </td></tr> + <tr><td class="paramname">eval</td><td>the exit code to exit with </td></tr> + <tr><td class="paramname">code</td><td>error code of the last error </td></tr> + <tr><td class="paramname">fmt</td><td>message to print </td></tr> + </table> + </dd> +</dl> + </div> -<div class="memdoc"> +</div> +<a id="ga1b898cb64c7e0e9a61d52440e1ada17e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga1b898cb64c7e0e9a61d52440e1ada17e">◆ </a></span>krb5_errx()</h2> -<p> -Convert the getaddrinfo() error code to a Kerberos et error code.<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign="top"></td><td valign="top"><em>eai_errno</em> </td><td>contains the error code from getaddrinfo(). </td></tr> - <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> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_errx </td> + <td>(</td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>eval</em>, </td> + </tr> + <tr> + <td class="paramkey"></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>Log a warning to the log, default stderr, and then exit.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>A Kerberos 5 context </td></tr> + <tr><td class="paramname">eval</td><td>the exit code to exit with </td></tr> + <tr><td class="paramname">fmt</td><td>message to print </td></tr> </table> + </dd> </dl> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Kerberos error code representing the EAI errors. </dd></dl> </div> -</div><p> -<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)" --> +</div> +<a id="gaaf6afd30b2a89fe2e9a4ace03626921e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaaf6afd30b2a89fe2e9a4ace03626921e">◆ </a></span>krb5_free_error_message()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_h_errno_to_heim_errno </td> + <td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_free_error_message </td> <td>(</td> - <td class="paramtype">int </td> - <td class="paramname"> <em>eai_errno</em> </td> - <td> ) </td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>msg</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> </tr> </table> +</div><div class="memdoc"> +<p>Free the error message returned by <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>Kerberos context </td></tr> + <tr><td class="paramname">msg</td><td>error message to free, returned byg <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </td></tr> + </table> + </dd> +</dl> + +</div> </div> -<div class="memdoc"> +<a id="ga35cbf80e68f43a6d9503952886b85ed2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga35cbf80e68f43a6d9503952886b85ed2">◆ </a></span>krb5_get_error_message()</h2> -<p> -Convert the gethostname() error code (h_error) to a Kerberos et error code.<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign="top"></td><td valign="top"><em>eai_errno</em> </td><td>contains the error code from gethostname().</td></tr> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL krb5_get_error_message </td> + <td>(</td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">krb5_error_code </td> + <td class="paramname"><em>code</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return the error message for `code' in context. On memory allocation error the function returns NULL.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>Kerberos 5 context </td></tr> + <tr><td class="paramname">code</td><td>Error code related to the error</td></tr> </table> + </dd> </dl> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Kerberos error code representing the gethostname errors. </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>an error string, needs to be freed with <a class="el" href="group__krb5__error.html#gaaf6afd30b2a89fe2e9a4ace03626921e">krb5_free_error_message()</a>. The functions return NULL on error. </dd></dl> </div> -</div><p> -<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" --> +</div> +<a id="ga785866fad6a16f78e398220bea3c079e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga785866fad6a16f78e398220bea3c079e">◆ </a></span>krb5_get_error_string()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_error_message </td> + <td class="memname">KRB5_LIB_FUNCTION char* KRB5_LIB_CALL krb5_get_error_string </td> <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"> <em>context</em>, </td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return the error message in context. On error or no error string, the function returns NULL.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>Kerberos 5 context</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>an error string, needs to be freed with <a class="el" href="group__krb5__error.html#gaaf6afd30b2a89fe2e9a4ace03626921e">krb5_free_error_message()</a>. The functions return NULL on error. </dd></dl> + +</div> +</div> +<a id="ga41e3138a66264a087ec916d0d5704ff9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga41e3138a66264a087ec916d0d5704ff9">◆ </a></span>krb5_get_warn_dest()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION krb5_log_facility* KRB5_LIB_CALL krb5_get_warn_dest </td> + <td>(</td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Get the default logging facility.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>A Kerberos 5 context </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaf04d419f89c5d4525f05f08710aed85e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf04d419f89c5d4525f05f08710aed85e">◆ </a></span>krb5_h_errno_to_heim_errno()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_h_errno_to_heim_errno </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>eai_errno</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Convert the gethostname() error code (h_error) to a Kerberos et error code.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">eai_errno</td><td>contains the error code from gethostname().</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Kerberos error code representing the gethostname errors. </dd></dl> + +</div> +</div> +<a id="ga0640bed1721367716746fb6cc6bf56dd"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0640bed1721367716746fb6cc6bf56dd">◆ </a></span>krb5_set_error_message()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_error_message </td> + <td>(</td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">krb5_error_code </td> - <td class="paramname"> <em>ret</em>, </td> + <td class="paramtype">krb5_error_code </td> + <td class="paramname"><em>ret</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"> <em>fmt</em>, </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><td> </td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> </tr> <tr> <td></td> <td>)</td> - <td></td><td></td><td></td> + <td></td><td></td> </tr> </table> +</div><div class="memdoc"> +<p>Set the context full error string for a specific error code. The error that is stored should be internationalized.</p> +<p>The if context is NULL, no error string is stored.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>Kerberos 5 context </td></tr> + <tr><td class="paramname">ret</td><td>The error code </td></tr> + <tr><td class="paramname">fmt</td><td>Error string for the error code </td></tr> + <tr><td class="paramname">...</td><td>printf(3) style parameters. </td></tr> + </table> + </dd> +</dl> + +</div> </div> -<div class="memdoc"> +<a id="gac3e03d80523f1f848d7d1f8b170dd8f9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac3e03d80523f1f848d7d1f8b170dd8f9">◆ </a></span>krb5_set_warn_dest()</h2> -<p> -Set the context full error string for a specific error code. The error that is stored should be internationalized.<p> -The if context is NULL, no error string is stored.<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>Kerberos 5 context </td></tr> - <tr><td valign="top"></td><td valign="top"><em>ret</em> </td><td>The error code </td></tr> - <tr><td valign="top"></td><td valign="top"><em>fmt</em> </td><td>Error string for the error code </td></tr> - <tr><td valign="top"></td><td valign="top"><em>...</em> </td><td>printf(3) style parameters. </td></tr> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_warn_dest </td> + <td>(</td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">krb5_log_facility * </td> + <td class="paramname"><em>fac</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the default logging facility.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>A Kerberos 5 context </td></tr> + <tr><td class="paramname">fac</td><td>Facility to use for logging. </td></tr> </table> + </dd> </dl> </div> -</div><p> -<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" --> +</div> +<a id="gaefd5e28eb27e811b3d76850d69f680da"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaefd5e28eb27e811b3d76850d69f680da">◆ </a></span>krb5_vabort()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_vwarn </td> + <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_vabort </td> <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"> <em>context</em>, </td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">krb5_error_code </td> - <td class="paramname"> <em>code</em>, </td> + <td class="paramtype">krb5_error_code </td> + <td class="paramname"><em>code</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"> <em>fmt</em>, </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">va_list </td> - <td class="paramname"> <em>ap</em></td><td> </td> + <td class="paramtype">va_list </td> + <td class="paramname"><em>ap</em> </td> </tr> <tr> <td></td> <td>)</td> - <td></td><td></td><td></td> + <td></td><td></td> </tr> </table> +</div><div class="memdoc"> +<p>Log a warning to the log, default stderr, include bthe error from the last failure and then abort.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>A Kerberos 5 context </td></tr> + <tr><td class="paramname">code</td><td>error code of the last error </td></tr> + <tr><td class="paramname">fmt</td><td>message to print </td></tr> + <tr><td class="paramname">ap</td><td>arguments </td></tr> + </table> + </dd> +</dl> + </div> -<div class="memdoc"> +</div> +<a id="gadbae318ed4838e81566c36b545db7b35"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gadbae318ed4838e81566c36b545db7b35">◆ </a></span>krb5_verr()</h2> -<p> -Log a warning to the log, default stderr, include the error from the last failure.<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>A Kerberos 5 context. </td></tr> - <tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>error code of the last error </td></tr> - <tr><td valign="top"></td><td valign="top"><em>fmt</em> </td><td>message to print </td></tr> - <tr><td valign="top"></td><td valign="top"><em>ap</em> </td><td>arguments </td></tr> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_verr </td> + <td>(</td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>eval</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">krb5_error_code </td> + <td class="paramname"><em>code</em>, </td> + </tr> + <tr> + <td class="paramkey"></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">va_list </td> + <td class="paramname"><em>ap</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Log a warning to the log, default stderr, include bthe error from the last failure and then exit.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>A Kerberos 5 context </td></tr> + <tr><td class="paramname">eval</td><td>the exit code to exit with </td></tr> + <tr><td class="paramname">code</td><td>error code of the last error </td></tr> + <tr><td class="paramname">fmt</td><td>message to print </td></tr> + <tr><td class="paramname">ap</td><td>arguments </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaa908a3716343e49cf0b9dd681b018700"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa908a3716343e49cf0b9dd681b018700">◆ </a></span>krb5_verrx()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_verrx </td> + <td>(</td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>eval</em>, </td> + </tr> + <tr> + <td class="paramkey"></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">va_list </td> + <td class="paramname"><em>ap</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Log a warning to the log, default stderr, and then exit.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>A Kerberos 5 context </td></tr> + <tr><td class="paramname">eval</td><td>the exit code to exit with </td></tr> + <tr><td class="paramname">fmt</td><td>message to print </td></tr> + <tr><td class="paramname">ap</td><td>arguments </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaf106c9897306a7d9b5cd10c467d6e382"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf106c9897306a7d9b5cd10c467d6e382">◆ </a></span>krb5_vprepend_error_message()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_vprepend_error_message </td> + <td>(</td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">krb5_error_code </td> + <td class="paramname"><em>ret</em>, </td> + </tr> + <tr> + <td class="paramkey"></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">va_list </td> + <td class="paramname"><em>args</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Prepend the contexts's full error string for a specific error code.</p> +<p>The if context is NULL, no error string is stored.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>Kerberos 5 context </td></tr> + <tr><td class="paramname">ret</td><td>The error code </td></tr> + <tr><td class="paramname">fmt</td><td>Error string for the error code </td></tr> + <tr><td class="paramname">args</td><td>printf(3) style parameters. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga19a03dbcbff7cc04e3756ac7a9f14385"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga19a03dbcbff7cc04e3756ac7a9f14385">◆ </a></span>krb5_vset_error_message()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_vset_error_message </td> + <td>(</td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">krb5_error_code </td> + <td class="paramname"><em>ret</em>, </td> + </tr> + <tr> + <td class="paramkey"></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">va_list </td> + <td class="paramname"><em>args</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the context full error string for a specific error code.</p> +<p>The if context is NULL, no error string is stored.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>Kerberos 5 context </td></tr> + <tr><td class="paramname">ret</td><td>The error code </td></tr> + <tr><td class="paramname">fmt</td><td>Error string for the error code </td></tr> + <tr><td class="paramname">args</td><td>printf(3) style parameters. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaab4d0325ff2a30fbd670d6e96c68b8ec"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaab4d0325ff2a30fbd670d6e96c68b8ec">◆ </a></span>krb5_vwarn()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_vwarn </td> + <td>(</td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">krb5_error_code </td> + <td class="paramname"><em>code</em>, </td> + </tr> + <tr> + <td class="paramkey"></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">va_list </td> + <td class="paramname"><em>ap</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Log a warning to the log, default stderr, include the error from the last failure.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> + <tr><td class="paramname">code</td><td>error code of the last error </td></tr> + <tr><td class="paramname">fmt</td><td>message to print </td></tr> + <tr><td class="paramname">ap</td><td>arguments </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gac1c13284b5c34f1f207423693ec7fdae"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac1c13284b5c34f1f207423693ec7fdae">◆ </a></span>krb5_vwarnx()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_vwarnx </td> + <td>(</td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></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">va_list </td> + <td class="paramname"><em>ap</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Log a warning to the log, default stderr.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> + <tr><td class="paramname">fmt</td><td>message to print </td></tr> + <tr><td class="paramname">ap</td><td>arguments </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gac25b2bfae99043329f1d9eb38c63cbe5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac25b2bfae99043329f1d9eb38c63cbe5">◆ </a></span>krb5_warn()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_warn </td> + <td>(</td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">krb5_error_code </td> + <td class="paramname"><em>code</em>, </td> + </tr> + <tr> + <td class="paramkey"></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>Log a warning to the log, default stderr, include the error from the last failure.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> + <tr><td class="paramname">code</td><td>error code of the last error </td></tr> + <tr><td class="paramname">fmt</td><td>message to print </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gafa3c8de06d8bc7205ff1ec9c379d2cb3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gafa3c8de06d8bc7205ff1ec9c379d2cb3">◆ </a></span>krb5_warnx()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_warnx </td> + <td>(</td> + <td class="paramtype">krb5_context </td> + <td class="paramname"><em>context</em>, </td> + </tr> + <tr> + <td class="paramkey"></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>Log a warning to the log, default stderr.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> + <tr><td class="paramname">fmt</td><td>message to print </td></tr> </table> + </dd> </dl> </div> -</div><p> </div> +</div><!-- contents --> <hr size="1"><address style="text-align: right;"><small> -Generated 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> +Generated on Fri Dec 8 2017 03:48:59 for HeimdalKerberos5library by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.8.13</small></address> </body> </html> |
