<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>krb5_parse_name()--Create Kerberos Principal from Text String</title>
<!-- Begin Header Records -->
<!-- All rights reserved. Licensed Materials Property of IBM          -->
<!-- US Government Users Restricted Rights                            -->
<!-- Use, duplication or disclosure restricted by                     -->
<!-- GSA ADP Schedule Contract with IBM Corp.                         -->
<!-- Change History:                                                  -->
<!--    YYMMDD USERID Change description                              -->
<!-- Created by Kent Hofer for V5R1 -->
<!-- Edited by Kersten Jan 02 -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- End Header Records -->
<!--Java sync-link-->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>

<a name="Top_Of_Page"></a> 

<h2>krb5_parse_name()--Create Kerberos Principal from Text String</h2>

<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax 

<pre>
 #include &lt;krb5.h&gt;

 krb5_error_code krb5_parse_name(
     krb5_context       <em>context</em>,
     krb5_const char *      <em>name</em>,
     krb5_principal *     <em>principal</em>);  
</pre>

&nbsp;&nbsp;Service Program Name: QSYS/QKRBGSS<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>

<p>The <strong>krb5_parse_name()</strong> routine converts a text string into a
Kerberos principal. The string must be in the format
<strong>name@realm</strong>. If the realm is not specified, the default realm
is used. Each forward slash in the name starts a new name component unless it
is escaped by preceding the forward slash with a backward slash. Forward
slashes in the realm are not treated as component separators and are copied
unchanged.</p>

<p>Not every coded character set identifier (CCSID) contains the '@' character;
however, alternative CCSID values often are available. For example, instead of
using Greece 423, run the job with a default CCSID of 875.</p>

<br>
<h3>Authorities</h3>

<p>No authorities are required.</p>

<br>
<h3>Parameters</h3>

<dl>
<dt><strong>context</strong>&nbsp;&nbsp;(Input)</dt>

<dd>The Kerberos context.<br>
<br>
</dd>

<dt><strong>name</strong>&nbsp;&nbsp;(Input)</dt>

<dd>The string to be parsed. The string must be in the format
<strong>name@realm</strong>.<br>
<br>
</dd>

<dt><strong>principal</strong>&nbsp;&nbsp;(Output)</dt>

<dd>The Kerberos principal. The <strong>krb5_free_principal()</strong> routine
should be called to release the principal when it is no longer needed.</dd>
</dl>

<br>
 

<h3>Return Value</h3>

<p>If no errors occur, the return value is 0. Otherwise, a Kerberos error code
is returned.</p>

<br>
 

<h3>Error Messages</h3>

<table width="100%" cellpadding="5">
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>

<tr>
<td width="15%" valign="top">CPE3418 E</td>
<td width="85%" valign="top">Possible APAR condition or hardware failure.</td>
</tr>
</table>

<br>
 

<hr>
API introduced: V5R1

<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"sec.htm">Security APIs</a> <br>
<a href="unix.htm">UNIX-Type APIs</a> | <a href="aplist.htm">APIs by
category</a> </td>
</tr>
</table>
</center>
</body>
</html>