gss_display_status()--Get Textual Representation of GSS Status Code or Mechanism Code
Syntax
#include <gssapi.h> OM_uint32 gss_display_status( OM_uint32 * minor_status, OM_uint32 status_value, int status_type, gss_OID mech_type, gss_msg_ctx_t * message_context, gss_buffer_t status_string);Service Program Name: QSYS/QKRBGSS
Default public authority: *USE
Threadsafe: Yes
The gss_display_status() 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.
Parameters
- minor_status (Output)
- A status code from the security mechanism.
- status_value (Input)
- The status value to be converted. A status value of zero is not valid and
causes the gss_display_status() routine to return a major
status of GSS_S_BAD_STATUS to the application.
- status_type (Input)
- The status value type. The status value type must be one of the
following:
GSS_C_GSS_CODE GSS major status code GSS_C_MECH_CODE Mechanism minor status code
- mech_type (Input)
- The security mechanism associated with a minor status code. This parameter
is used only when converting a minor status code.
- message_context (Input/Output)
- Whether the status code has multiples messages to be processed. The first
time an application calls gss_display_status(), the
message_context parameter must be initialized to zero. The
gss_display_status() routine returns the first message and
sets the message_context parameter to a nonzero value if more messages
are available. The application then continues to call the
gss_display_status() routine to obtain the additional messages
until the message_context value is zero upon return from the
gss_display_status() routine.
- status_string (Output)
- The text message for the status value.
Return Value
The return value is one of the following status codes:
- GSS_S_BAD_MECH
- The mechanism specified by the mech_type parameter is not
supported.
- GSS_S_BAD_STATUS
- The value of the status_type parameter is not
GSS_C_GSS_CODE or GSS_C_MECH_CODE or the
value of the status_value parameter is not a valid status code.
- GSS_S_COMPLETE
- The routine completed successfully.
- GSS_S_FAILURE
- The routine failed for reasons that are not defined at the GSS level. The minor_status return parameter contains a mechanism-dependent error code describing the reason for the failure.
Authorities
Object Referred to | Data Authority Required |
---|---|
Each directory in the path name preceding the configuration file | *X |
Configuration file | *R |
Error Messages
Message ID | Error Message Text |
---|---|
CPE3418 E | Possible APAR condition or hardware failure. |
Usage Notes
- The message_context parameter indicates which error message should be returned when a status code has multiple messages. The first time an application calls the gss_display_status() routine, it must initialize the message_context value to zero. The gss_display_status() routine then returns the first message for the status code and sets message_context to a nonzero value if there are additional messages available. The application can then continue to call gss_display_status() until the message_context value is zero upon return.
API introduced: V5R1
[ Back to top | Security APIs | UNIX-Type APIs | APIs by category ]