diff options
Diffstat (limited to 'doc/html/appdev/refs/api/krb5_cc_select.html')
| -rw-r--r-- | doc/html/appdev/refs/api/krb5_cc_select.html | 26 |
1 files changed, 12 insertions, 14 deletions
diff --git a/doc/html/appdev/refs/api/krb5_cc_select.html b/doc/html/appdev/refs/api/krb5_cc_select.html index 3297d4ddfaf4..9741afd5b42f 100644 --- a/doc/html/appdev/refs/api/krb5_cc_select.html +++ b/doc/html/appdev/refs/api/krb5_cc_select.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_cc_select - Select a credential cache to use with a server principal. — MIT Kerberos Documentation</title> - + <title>krb5_cc_select - Select a credential cache to use with a server principal. — 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_cc_set_config - Store a configuration value in a credential cache." href="krb5_cc_set_config.html" /> <link rel="prev" title="krb5_cc_retrieve_cred - Retrieve a specified credentials from a credential cache." href="krb5_cc_retrieve_cred.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-cc-select-select-a-credential-cache-to-use-with-a-server-principal"> <h1>krb5_cc_select - Select a credential cache to use with a server principal.<a class="headerlink" href="#krb5-cc-select-select-a-credential-cache-to-use-with-a-server-principal" title="Permalink to this headline">¶</a></h1> <dl class="function"> <dt id="c.krb5_cc_select"> -<a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a> <tt class="descname">krb5_cc_select</tt><big>(</big><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a><em> context</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> server</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a> *<em> cache_out</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> *<em> princ_out</em><big>)</big><a class="headerlink" href="#c.krb5_cc_select" title="Permalink to this definition">¶</a></dt> +<a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a> <code class="descname">krb5_cc_select</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> context</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> server</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a> *<em> cache_out</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> *<em> princ_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_select" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <table class="docutils field-list" frame="void" rules="none"> @@ -94,7 +92,7 @@ </tbody> </table> <p>Select a cache within the collection containing credentials most appropriate for use with <em>server</em> , according to configured rules and heuristics.</p> -<p>Use <a class="reference internal" href="krb5_cc_close.html#c.krb5_cc_close" title="krb5_cc_close"><tt class="xref c c-func docutils literal"><span class="pre">krb5_cc_close()</span></tt></a> to release <em>cache_out</em> when it is no longer needed. Use <a class="reference internal" href="krb5_free_principal.html#c.krb5_free_principal" title="krb5_free_principal"><tt class="xref c c-func docutils literal"><span class="pre">krb5_free_principal()</span></tt></a> to release <em>princ_out</em> when it is no longer needed. Note that <em>princ_out</em> is set in some error conditions.</p> +<p>Use <a class="reference internal" href="krb5_cc_close.html#c.krb5_cc_close" title="krb5_cc_close"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_close()</span></code></a> to release <em>cache_out</em> when it is no longer needed. Use <a class="reference internal" href="krb5_free_principal.html#c.krb5_free_principal" title="krb5_free_principal"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_principal()</span></code></a> to release <em>princ_out</em> when it is no longer needed. Note that <em>princ_out</em> is set in some error conditions.</p> <p>If the appropriate client principal can be authoritatively determined but the cache collection contains no credentials for that principal, then KRB5_CC_NOTFOUND is returned, <em>cache_out</em> is set to NULL, and <em>princ_out</em> is set to the appropriate client principal.</p> <p>If no configured mechanism can determine the appropriate cache or principal, KRB5_CC_NOTFOUND is returned and <em>cache_out</em> and <em>princ_out</em> are set to NULL.</p> <p>Any other error code indicates a fatal error in the processing of a cache selection mechanism.</p> @@ -160,8 +158,8 @@ <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"> |
