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_cc_default_name.html | |
| parent | b0e4d68d5124581ae353493d69bea352de4cff8a (diff) | |
Diffstat (limited to 'doc/html/appdev/refs/api/krb5_cc_default_name.html')
| -rw-r--r-- | doc/html/appdev/refs/api/krb5_cc_default_name.html | 28 |
1 files changed, 13 insertions, 15 deletions
diff --git a/doc/html/appdev/refs/api/krb5_cc_default_name.html b/doc/html/appdev/refs/api/krb5_cc_default_name.html index e7c0a3c4010c..2cc9c32dc3d6 100644 --- a/doc/html/appdev/refs/api/krb5_cc_default_name.html +++ b/doc/html/appdev/refs/api/krb5_cc_default_name.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_default_name - Return the name of the default credential cache. — MIT Kerberos Documentation</title> - + <title>krb5_cc_default_name - Return the name of the default credential cache. — 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_destroy - Destroy a credential cache." href="krb5_cc_destroy.html" /> <link rel="prev" title="krb5_cc_default - Resolve the default credential cache name." href="krb5_cc_default.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-default-name-return-the-name-of-the-default-credential-cache"> <h1>krb5_cc_default_name - Return the name of the default credential cache.<a class="headerlink" href="#krb5-cc-default-name-return-the-name-of-the-default-credential-cache" title="Permalink to this headline">¶</a></h1> <dl class="function"> <dt id="c.krb5_cc_default_name"> -const char * <tt class="descname">krb5_cc_default_name</tt><big>(</big><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a><em> context</em><big>)</big><a class="headerlink" href="#c.krb5_cc_default_name" title="Permalink to this definition">¶</a></dt> +const char * <code class="descname">krb5_cc_default_name</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><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_default_name" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <table class="docutils field-list" frame="void" rules="none"> @@ -89,8 +87,8 @@ const char * <tt class="descname">krb5_cc_default_name</tt><big>(</big><a class= </tr> </tbody> </table> -<p>Return a pointer to the default credential cache name for <em>context</em> , as determined by a prior call to <a class="reference internal" href="krb5_cc_set_default_name.html#c.krb5_cc_set_default_name" title="krb5_cc_set_default_name"><tt class="xref c c-func docutils literal"><span class="pre">krb5_cc_set_default_name()</span></tt></a> , by the KRB5CCNAME environment variable, by the default_ccache_name profile variable, or by the operating system or build-time default value. The returned value must not be modified or freed by the caller. The returned value becomes invalid when <em>context</em> is destroyed <a class="reference internal" href="krb5_free_context.html#c.krb5_free_context" title="krb5_free_context"><tt class="xref c c-func docutils literal"><span class="pre">krb5_free_context()</span></tt></a> or if a subsequent call to <a class="reference internal" href="krb5_cc_set_default_name.html#c.krb5_cc_set_default_name" title="krb5_cc_set_default_name"><tt class="xref c c-func docutils literal"><span class="pre">krb5_cc_set_default_name()</span></tt></a> is made on <em>context</em> .</p> -<p>The default credential cache name is cached in <em>context</em> between calls to this function, so if the value of KRB5CCNAME changes in the process environment after the first call to this function on, that change will not be reflected in later calls with the same context. The caller can invoke <a class="reference internal" href="krb5_cc_set_default_name.html#c.krb5_cc_set_default_name" title="krb5_cc_set_default_name"><tt class="xref c c-func docutils literal"><span class="pre">krb5_cc_set_default_name()</span></tt></a> with a NULL value of <em>name</em> to clear the cached value and force the default name to be recomputed.</p> +<p>Return a pointer to the default credential cache name for <em>context</em> , as determined by a prior call to <a class="reference internal" href="krb5_cc_set_default_name.html#c.krb5_cc_set_default_name" title="krb5_cc_set_default_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_set_default_name()</span></code></a> , by the KRB5CCNAME environment variable, by the default_ccache_name profile variable, or by the operating system or build-time default value. The returned value must not be modified or freed by the caller. The returned value becomes invalid when <em>context</em> is destroyed <a class="reference internal" href="krb5_free_context.html#c.krb5_free_context" title="krb5_free_context"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_context()</span></code></a> or if a subsequent call to <a class="reference internal" href="krb5_cc_set_default_name.html#c.krb5_cc_set_default_name" title="krb5_cc_set_default_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_set_default_name()</span></code></a> is made on <em>context</em> .</p> +<p>The default credential cache name is cached in <em>context</em> between calls to this function, so if the value of KRB5CCNAME changes in the process environment after the first call to this function on, that change will not be reflected in later calls with the same context. The caller can invoke <a class="reference internal" href="krb5_cc_set_default_name.html#c.krb5_cc_set_default_name" title="krb5_cc_set_default_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_set_default_name()</span></code></a> with a NULL value of <em>name</em> to clear the cached value and force the default name to be recomputed.</p> </div> @@ -149,8 +147,8 @@ const char * <tt class="descname">krb5_cc_default_name</tt><big>(</big><a class= <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"> |