242 lines
6.5 KiB
HTML
242 lines
6.5 KiB
HTML
|
<!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>gss_display_status()--Get Textual Representation of GSS Status Code or
|
||
|
|
Mechanism Code</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: -->
|
||
|
|
<!-- Edited by Kersten Jan 02 -->
|
||
|
|
<!-- Created by Kent Hofer for V5R1 -->
|
||
|
|
<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>gss_display_status()--Get Textual Representation of GSS Status Code or
|
||
|
|
Mechanism Code</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 60%;">
|
||
|
|
<br>
|
||
|
|
Syntax
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
#include <gssapi.h>
|
||
|
|
|
||
|
|
OM_uint32 gss_display_status(
|
||
|
|
OM_uint32 * <em>minor_status</em>,
|
||
|
|
OM_uint32 <em>status_value</em>,
|
||
|
|
int <em>status_type</em>,
|
||
|
|
gss_OID <em>mech_type</em>,
|
||
|
|
gss_msg_ctx_t * <em>message_context</em>,
|
||
|
|
gss_buffer_t <em>status_string</em>);
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
Service Program Name: QSYS/QKRBGSS<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Default public authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The <strong>gss_display_status()</strong> function provides an application
|
||
|
|
with a textual representation of a GSS or mechanism status code. The returned
|
||
|
|
message can then be displayed to the user or written to a log file.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Parameters</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>minor_status</strong> (Output)</dt>
|
||
|
|
|
||
|
|
<dd>A status code from the security mechanism.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>status_value</strong> (Input)</dt>
|
||
|
|
|
||
|
|
<dd>The status value to be converted. A status value of zero is not valid and
|
||
|
|
causes the <strong>gss_display_status()</strong> routine to return a major
|
||
|
|
status of <strong>GSS_S_BAD_STATUS</strong> to the application.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>status_type</strong> (Input)</dt>
|
||
|
|
|
||
|
|
<dd>The status value type. The status value type must be one of the
|
||
|
|
following:<br>
|
||
|
|
<br>
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="25 75" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>GSS_C_GSS_CODE</em></td>
|
||
|
|
<td align="left" valign="top">GSS major status code</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>GSS_C_MECH_CODE</em></td>
|
||
|
|
<td align="left" valign="top">Mechanism minor status code</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>mech_type</strong> (Input)</dt>
|
||
|
|
|
||
|
|
<dd>The security mechanism associated with a minor status code. This parameter
|
||
|
|
is used only when converting a minor status code.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>message_context</strong> (Input/Output)</dt>
|
||
|
|
|
||
|
|
<dd>Whether the status code has multiples messages to be processed. The first
|
||
|
|
time an application calls <strong>gss_display_status()</strong>, the
|
||
|
|
<em>message_context</em> parameter must be initialized to zero. The
|
||
|
|
<strong>gss_display_status()</strong> routine returns the first message and
|
||
|
|
sets the <em>message_context</em> parameter to a nonzero value if more messages
|
||
|
|
are available. The application then continues to call the
|
||
|
|
<strong>gss_display_status()</strong> routine to obtain the additional messages
|
||
|
|
until the <em>message_context</em> value is zero upon return from the
|
||
|
|
<strong>gss_display_status()</strong> routine.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>status_string</strong> (Output)</dt>
|
||
|
|
|
||
|
|
<dd>The text message for the status value.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Return Value</h3>
|
||
|
|
|
||
|
|
<p>The return value is one of the following status codes:</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>GSS_S_BAD_MECH</strong></dt>
|
||
|
|
|
||
|
|
<dd>The mechanism specified by the <em>mech_type</em> parameter is not
|
||
|
|
supported.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>GSS_S_BAD_STATUS</strong></dt>
|
||
|
|
|
||
|
|
<dd>The value of the <em>status_type</em> parameter is not
|
||
|
|
<strong>GSS_C_GSS_CODE</strong> or <strong>GSS_C_MECH_CODE</strong> or the
|
||
|
|
value of the <em>status_value</em> parameter is not a valid status code.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>GSS_S_COMPLETE</strong></dt>
|
||
|
|
|
||
|
|
<dd>The routine completed successfully.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>GSS_S_FAILURE</strong></dt>
|
||
|
|
|
||
|
|
<dd>The routine failed for reasons that are not defined at the GSS level. The
|
||
|
|
<em>minor_status</em> return parameter contains a mechanism-dependent error
|
||
|
|
code describing the reason for the failure.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities</h3>
|
||
|
|
|
||
|
|
<table border width="80%">
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="bottom">Object Referred to</th>
|
||
|
|
<th align="center" valign="bottom">Data Authority Required</th>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">Each directory in the path name preceding the
|
||
|
|
configuration file</td>
|
||
|
|
<td align="center" valign="top">*X</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">Configuration file</td>
|
||
|
|
<td align="center" valign="top">*R</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<table width="100%" cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<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>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Usage Notes</h3>
|
||
|
|
|
||
|
|
<ol>
|
||
|
|
<li>The <em>message_context</em> parameter indicates which error message should
|
||
|
|
be returned when a status code has multiple messages. The first time an
|
||
|
|
application calls the <strong>gss_display_status()</strong> routine, it must
|
||
|
|
initialize the <em>message_context</em> value to zero. The
|
||
|
|
<strong>gss_display_status()</strong> routine then returns the first message
|
||
|
|
for the status code and sets <em>message_context</em> to a nonzero value if
|
||
|
|
there are additional messages available. The application can then continue to
|
||
|
|
call <strong>gss_display_status()</strong> until the <em>message_context</em>
|
||
|
|
value is zero upon return.</li>
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|