gss_display_status(3)gss_display_status(3)NAMEgss_display_status - Convert GSS-API return codes to text.
SYNOPSIS
#include <gssapi/gssapi.h>
OM_uint32 gss_display_status(
OM_uint32 * minor_status,
OM_uint32 status_value,
int status_type,
const gss_OID mech_type,
OM_uint32 * message_context,
gss_buffer_t status_string );
PARAMETERS
Kerberos 5 error code. Status value to be converted to text.
GSS_C_GSS_CODE -- GSS-API major status code.
GSS_C_MECH_CODE -- Kerberos 5 minor status code. Object identi‐
fier (OID) of the security mechanism used to interpret a minor
status value. Specify GSS_C_NO_OID to obtain the Kerberos 5
default. Output indicator for displaying multiple status codes.
Specify zero on the first call to this function. If further mes‐
sages are contained in the status_value parameter, this parame‐
ter is set to a non-zero value. This parameter must be specified
in subsequent calls, along with the same values for the sta‐
tus_value, status_type, and mech_type parameters. Text inter‐
pretation of the status_value parameter. All returned strings
are terminated with a NULL character. The length of the sta‐
tus_string parameter does not include the NULL.
The application must release this buffer after use with a call
to gss_release_buffer().
DESCRIPTION
The gss_display_status() function returns text representations of GSS-
API status codes for display to the user or for logging purposes. Since
some status codes may indicate multiple errors, applications may need
to call this function multiple times until the message_context parame‐
ter is set to zero. Each call always returns a single text string.
Storage associated with the text strings must be freed by the applica‐
tion after use with a call to gss_release_buffer().
RETURN VALUES
GSS_S_BAD_MECH xx01xxxx
GSS_S_BAD_STATUS xx05xxxx
GSS_S_CALL_BAD_STRUCTURE 03xxxxxx
GSS_S_CALL_INACCESSIBLE_READ 01xxxxxx
GSS_S_CALL_INACCESSIBLE_WRITE 02xxxxxx
GSS_S_COMPLETE 00000000
GSS_S_FAILURE xx0Dxxxx
SEE ALSO
Functions: gss_release_buffer(3)gss_display_status(3)
