GSS_DISPLAY_STATUS(3) Programmer's Manual GSS_DISPLAY_STATUS(3)NAMEgss_display_status — Convert a GSS-API status code to text
gss_display_status(OM_uint32 *minor_status, OM_uint32 status_value,
int status_type, const gss_OID mech_type, OM_uint32 *message_context,
Allows an application to obtain a textual representation of a GSS-API
status code, for display to the user or for logging purposes. Since some
status values may indicate multiple conditions, applications may need to
call gss_display_status() multiple times, each call generating a single
text string. The message_context parameter is used by
gss_display_status() to store state information about which error mes‐
sages have already been extracted from a given status_value;
message_context must be initialized to zero by the application prior to
the first call, and gss_display_status() will return a non-zero value in
this parameter if there are further messages to extract.
The message_context parameter contains all state information required by
gss_display_status() in order to extract further messages from the
status_value; even when a non-zero value is returned in this parameter,
the application is not required to call gss_display_status() again unless
subsequent messages are desired. The following code extracts all mes‐
sages from a given status code and prints them to stderr:
message_context = 0;
maj_status = gss_display_status (
} while (message_context != 0);
minor_status Mechanism specific status code.
status_value Status value to be converted
status_value is a GSS status code
status_value is a mechanism status code
mech_type Underlying mechanism (used to interpret a minor status
value). Supply GSS_C_NO_OID to obtain the system default.
Should be initialized to zero by the application prior to
the first call. On return from gss_display_status(), a
non-zero status_value parameter indicates that additional
messages may be extracted from the status code via subse‐
quent calls to gss_display_status(), passing the same
status_value, status_type, mech_type, and message_context
Textual interpretation of the status_value. Storage asso‐
ciated with this parameter must be freed by the application
after use with a call to gss_release_buffer().
Indicates that translation in accordance with an unsup‐
ported mechanism type was requested
The status value was not recognized, or the status type was
neither GSS_C_GSS_CODE nor GSS_C_MECH_CODE.
RFC 2743 Generic Security Service Application Program Interface Ver‐
sion 2, Update 1
RFC 2744 Generic Security Service API Version 2 : C-bindings
The gss_display_status function first appeared in FreeBSD 7.0.
John Wray, Iris Associates
Copyright (C) The Internet Society (2000). All Rights Reserved.
This document and translations of it may be copied and furnished to oth‐
ers, and derivative works that comment on or otherwise explain it or
assist in its implementation may be prepared, copied, published and dis‐
tributed, in whole or in part, without restriction of any kind, provided
that the above copyright notice and this paragraph are included on all
such copies and derivative works. However, this document itself may not
be modified in any way, such as by removing the copyright notice or ref‐
erences to the Internet Society or other Internet organizations, except
as needed for the purpose of developing Internet standards in which case
the procedures for copyrights defined in the Internet Standards process
must be followed, or as required to translate it into languages other
The limited permissions granted above are perpetual and will not be
revoked by the Internet Society or its successors or assigns.
This document and the information contained herein is provided on an "AS
IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK
FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT
INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FIT‐
NESS FOR A PARTICULAR PURPOSE.
BSD January 26, 2010 BSD