diff options
Diffstat (limited to 'doc/html/appdev/refs/api/krb5_build_principal.html')
| -rw-r--r-- | doc/html/appdev/refs/api/krb5_build_principal.html | 98 |
1 files changed, 42 insertions, 56 deletions
diff --git a/doc/html/appdev/refs/api/krb5_build_principal.html b/doc/html/appdev/refs/api/krb5_build_principal.html index 4bb5add8c9a7..93c490cc4c0a 100644 --- a/doc/html/appdev/refs/api/krb5_build_principal.html +++ b/doc/html/appdev/refs/api/krb5_build_principal.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_build_principal - Build a principal name using null-terminated strings. — 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> <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="next" title="krb5_build_principal_alloc_va - Build a principal name, using a precomputed variable argument list." href="krb5_build_principal_alloc_va.html" /> <link rel="prev" title="krb5 API" href="index.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,55 +52,49 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-build-principal-build-a-principal-name-using-null-terminated-strings"> + <section id="krb5-build-principal-build-a-principal-name-using-null-terminated-strings"> <h1>krb5_build_principal - Build a principal name using null-terminated strings.<a class="headerlink" href="#krb5-build-principal-build-a-principal-name-using-null-terminated-strings" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_build_principal"> -<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_build_principal</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> princ</em>, unsigned int<em> rlen</em>, const char *<em> realm</em>, ...<span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_build_principal" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_build_principal"> +<a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code"><span class="n"><span class="pre">krb5_error_code</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_build_principal</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">princ</span></span>, <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">rlen</span></span>, <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="n"><span class="pre">realm</span></span>, <span class="p"><span class="pre">...</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_build_principal" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><p class="first"><strong>[in]</strong> <strong>context</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>context</strong> - Library context</p> <p><strong>[out]</strong> <strong>princ</strong> - Principal name</p> <p><strong>[in]</strong> <strong>rlen</strong> - Realm name length</p> -<p class="last"><strong>[in]</strong> <strong>realm</strong> - Realm name</p> -</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">retval:</th><td class="field-body"><ul class="first simple"> -<li>0 Success</li> +<p><strong>[in]</strong> <strong>realm</strong> - Realm name</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>0 Success</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>Call <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 free <em>princ</em> when it is no longer needed.</p> +</dd> +</dl> +<p>Call krb5_free_principal() to free <em>princ</em> when it is no longer needed.</p> <p>Beginning with release 1.20, the name type of the principal will be inferred as <strong>KRB5_NT_SRV_INST</strong> or <strong>KRB5_NT_WELLKNOWN</strong> based on the principal name. The type will be <strong>KRB5_NT_PRINCIPAL</strong> if a type cannot be inferred.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last"><a class="reference internal" href="#c.krb5_build_principal" title="krb5_build_principal"><code class="xref c c-func docutils literal"><span class="pre">krb5_build_principal()</span></code></a> and <a class="reference internal" href="krb5_build_principal_alloc_va.html#c.krb5_build_principal_alloc_va" title="krb5_build_principal_alloc_va"><code class="xref c c-func docutils literal"><span class="pre">krb5_build_principal_alloc_va()</span></code></a> perform the same task. <a class="reference internal" href="#c.krb5_build_principal" title="krb5_build_principal"><code class="xref c c-func docutils literal"><span class="pre">krb5_build_principal()</span></code></a> takes variadic arguments. <a class="reference internal" href="krb5_build_principal_alloc_va.html#c.krb5_build_principal_alloc_va" title="krb5_build_principal_alloc_va"><code class="xref c c-func docutils literal"><span class="pre">krb5_build_principal_alloc_va()</span></code></a> takes a pre-computed <em>varargs</em> pointer.</p> -</div> +<p class="admonition-title">Note</p> +<p>krb5_build_principal() and krb5_build_principal_alloc_va() perform the same task. krb5_build_principal() takes variadic arguments. krb5_build_principal_alloc_va() takes a pre-computed <em>varargs</em> pointer.</p> </div> +</section> + <div class="clearer"></div> </div> </div> </div> </div> <div class="sidebar"> + <h2>On this page</h2> <ul> <li><a class="reference internal" href="#">krb5_build_principal - Build a principal name using null-terminated strings.</a></li> @@ -153,6 +138,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -160,8 +146,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> |