diff options
| author | Cy Schubert <cy@FreeBSD.org> | 2023-08-04 17:53:10 +0000 |
|---|---|---|
| committer | Cy Schubert <cy@FreeBSD.org> | 2023-08-04 17:53:10 +0000 |
| commit | 0320e0d5bb9fbb5da53478b3fd80ad79b110191d (patch) | |
| tree | e1185f75bd2d3f87b0c17f787debc3ee8648214b /doc/html/appdev/refs/api/krb5_get_error_message.html | |
| parent | b0e4d68d5124581ae353493d69bea352de4cff8a (diff) | |
Diffstat (limited to 'doc/html/appdev/refs/api/krb5_get_error_message.html')
| -rw-r--r-- | doc/html/appdev/refs/api/krb5_get_error_message.html | 28 |
1 files changed, 13 insertions, 15 deletions
diff --git a/doc/html/appdev/refs/api/krb5_get_error_message.html b/doc/html/appdev/refs/api/krb5_get_error_message.html index 0a34c8067549..81e66f04a194 100644 --- a/doc/html/appdev/refs/api/krb5_get_error_message.html +++ b/doc/html/appdev/refs/api/krb5_get_error_message.html @@ -1,33 +1,31 @@ + <!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/html; charset=utf-8" /> - - <title>krb5_get_error_message - Get the (possibly extended) error message for a code. — MIT Kerberos Documentation</title> - + <title>krb5_get_error_message - Get the (possibly extended) error message for a code. — MIT Kerberos Documentation</title> <link rel="stylesheet" href="../../../_static/agogo.css" type="text/css" /> <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../../../_static/kerb.css" type="text/css" /> - <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../../../', - VERSION: '1.16', + VERSION: '1.21.1', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="../../../_static/jquery.js"></script> <script type="text/javascript" src="../../../_static/underscore.js"></script> <script type="text/javascript" src="../../../_static/doctools.js"></script> <link rel="author" title="About these documents" href="../../../about.html" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> <link rel="copyright" title="Copyright" href="../../../copyright.html" /> - <link rel="top" title="MIT Kerberos Documentation" href="../../../index.html" /> - <link rel="up" title="krb5 API" href="index.html" /> <link rel="next" title="krb5_get_host_realm - Get the Kerberos realm names for a host." href="krb5_get_host_realm.html" /> <link rel="prev" title="krb5_get_default_realm - Retrieve the default realm." href="krb5_get_default_realm.html" /> </head> @@ -61,13 +59,13 @@ <div class="documentwrapper"> <div class="bodywrapper"> - <div class="body"> + <div class="body" role="main"> <div class="section" id="krb5-get-error-message-get-the-possibly-extended-error-message-for-a-code"> <h1>krb5_get_error_message - Get the (possibly extended) error message for a code.<a class="headerlink" href="#krb5-get-error-message-get-the-possibly-extended-error-message-for-a-code" title="Permalink to this headline">¶</a></h1> <dl class="function"> <dt id="c.krb5_get_error_message"> -const char * <tt class="descname">krb5_get_error_message</tt><big>(</big><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a><em> ctx</em>, <a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a><em> code</em><big>)</big><a class="headerlink" href="#c.krb5_get_error_message" title="Permalink to this definition">¶</a></dt> +const char * <code class="descname">krb5_get_error_message</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a><em> ctx</em>, <a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a><em> code</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_error_message" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <table class="docutils field-list" frame="void" rules="none"> @@ -80,9 +78,9 @@ const char * <tt class="descname">krb5_get_error_message</tt><big>(</big><a clas </tr> </tbody> </table> -<p>The behavior of <a class="reference internal" href="#c.krb5_get_error_message" title="krb5_get_error_message"><tt class="xref c c-func docutils literal"><span class="pre">krb5_get_error_message()</span></tt></a> is only defined the first time it is called after a failed call to a krb5 function using the same context, and only when the error code passed in is the same as that returned by the krb5 function.</p> +<p>The behavior of <a class="reference internal" href="#c.krb5_get_error_message" title="krb5_get_error_message"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_error_message()</span></code></a> is only defined the first time it is called after a failed call to a krb5 function using the same context, and only when the error code passed in is the same as that returned by the krb5 function.</p> <p>This function never returns NULL, so its result may be used unconditionally as a C string.</p> -<p>The string returned by this function must be freed using <a class="reference internal" href="krb5_free_error_message.html#c.krb5_free_error_message" title="krb5_free_error_message"><tt class="xref c c-func docutils literal"><span class="pre">krb5_free_error_message()</span></tt></a></p> +<p>The string returned by this function must be freed using <a class="reference internal" href="krb5_free_error_message.html#c.krb5_free_error_message" title="krb5_free_error_message"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_error_message()</span></code></a></p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">Future versions may return the same string for the second and following calls.</p> @@ -145,8 +143,8 @@ const char * <tt class="descname">krb5_get_error_message</tt><big>(</big><a clas <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.16</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2017, MIT. + <div class="right" ><i>Release: 1.21.1</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. </div> <div class="left"> |