krb5: Import MIT 1.21.3 - src - FreeBSD source tree

diff options


context:
space:
mode:

author	Cy Schubert <cy@FreeBSD.org>	2025-03-19 22:12:25 +0000
committer	Cy Schubert <cy@FreeBSD.org>	2025-03-19 22:12:25 +0000
commit	8f7d3ef26dec89a92ec0665de84a5936310a5574 (patch)
tree	9a465418bd4056bf0d369751320a414eaed29fa4 /doc/html/appdev/refs/api/krb5_cc_default_name.html
parent	1a79b20663ca26acc2998b90ea2ff2aefd8af5b1 (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

1 files changed, 36 insertions, 49 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 705a42455905..eda52320090b 100644
--- a/doc/html/appdev/refs/api/krb5_cc_default_name.html
+++ b/doc/html/appdev/refs/api/krb5_cc_default_name.html

@@ -1,35 +1,26 @@

-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

+<!DOCTYPE html>

-<html xmlns="http://www.w3.org/1999/xhtml">

+<html>

<head>

- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

+ <meta charset="utf-8" />

+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<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.21.2',

- COLLAPSE_INDEX: false,

- FILE_SUFFIX: '.html',

- 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="stylesheet" type="text/css" href="../../../_static/pygments.css" />

+ <link rel="stylesheet" type="text/css" href="../../../_static/agogo.css" />

+ <link rel="stylesheet" type="text/css" href="../../../_static/kerb.css" />

+ <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>

+ <script src="../../../_static/jquery.js"></script>

+ <script src="../../../_static/underscore.js"></script>

+ <script src="../../../_static/doctools.js"></script>

- </head>

- <body>

+ </head><body>

@@ -61,42 +52,37 @@

- <div class="section" id="krb5-cc-default-name-return-the-name-of-the-default-credential-cache">

+ <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 * <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>

+<dl class="c function">

+<dt class="sig sig-object c" id="c.krb5_cc_default_name">

+<span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">krb5_cc_default_name</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context"><span class="n"><span class="pre">krb5_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">context</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_default_name" title="Permalink to this definition">¶</a><br /></dt>

-<table class="docutils field-list" frame="void" rules="none">

-<col class="field-name" />

-<col class="field-body" />

-<tbody valign="top">

-<tr class="field-odd field"><th class="field-name">param:</th><td class="field-body"><strong>[in]</strong> <strong>context</strong> - Library context</td>

-</tr>

-</tbody>

-</table>

-<table class="docutils field-list" frame="void" rules="none">

-<col class="field-name" />

-<col class="field-body" />

-<tbody valign="top">

-<tr class="field-odd field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple">

-<li>Name of default credential cache for the current user.</li>

+<dl class="field-list simple">

+<dt class="field-odd">param</dt>

+<dd class="field-odd"><p><strong>[in]</strong> <strong>context</strong> - Library context</p>

+</dd>

+</dl>

+<dl class="field-list simple">

+<dt class="field-odd">return</dt>

+<dd class="field-odd"><ul class="simple">

+<li><p>Name of default credential cache for the current user.</p></li>

</ul>

-</td>

-</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"><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>

+</dd>

+</dl>

+<p>Return a pointer to the default credential cache name for <em>context</em> , as determined by a prior call to krb5_cc_set_default_name(), 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 krb5_free_context() or if a subsequent call to krb5_cc_set_default_name() 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 krb5_cc_set_default_name() with a NULL value of <em>name</em> to clear the cached value and force the default name to be recomputed.</p>

+</section>

+ <div class="clearer"></div>

</div>

<ul>

<li><a class="reference internal" href="#">krb5_cc_default_name - Return the name of the default credential cache.</a></li>

@@ -140,6 +126,7 @@ const char * <code class="descname">krb5_cc_default_name</code><span class="sig-

</form>

</div>

</div>

@@ -147,8 +134,8 @@ const char * <code class="descname">krb5_cc_default_name</code><span class="sig-

- <div class="right" ><i>Release: 1.21.2</i><br />

+ <div class="right" ><i>Release: 1.21.3</i><br />

</div>