rpc_gss_get_error.3n (2010 09)

rpc_gss_get_error(3N) rpc_gss_get_error(3N)

NAME

rpc_gss_get_error() - get error codes on failure

SYNOPSIS

#include <rpc/rpcsec_gss.h>

bool_t rpc_gss_get_error(rpc_gss_error_t *

error );

DESCRIPTION

rpc_gss_get_error()

fetches an error code when an

RPCSEC_GSS routine fails.

rpc_gss_get_error()

uses a rpc_gss_error_t

structure of the following form:

typedef struct {

int rpc_gss_error; /* RPCSEC_GSS error */

int system_error; /* system error */

} rpc_gss_error_t;

Currently the only error codes deﬁned for this function are:

#define RPC_GSS_ER_SUCCESS 0 /* no error */

#define RPC_GSS_ER_SYSTEMERROR 1 /* system error */

PARAMETERS

For additional information on RPCSEC_GSS data types for parameters, see the rpcsec_gss (3N) manpage.

error A

rpc_gss_error_t

structure. If the rpc_gss_error ﬁeld is equal to

RPC_GSS_ER_SYSTEMERROR

, the system_error ﬁeld will be set to the value of errno.

MULTITHREAD USAGE

Thread Safe: Yes

Cancel Safe: Yes

Fork Safe: No

Async-cancel Safe: No

Async-signal Safe: No

These functions can be called safely in a multithreaded environment. They may be cancellation points in

that they call functions that are cancel points.

In a multithreaded environment, these functions are not safe to be called by a child process after

fork()

and before exec(). These functions should not be called by a multithreaded application that supports

asynchronous cancellation or asynchronous signals.

RETURN VALUE

Unless there is a failure indication from an invoked

RPCSEC_GSS function, rpc_gss_get_error()

does not set error to a meaningful value.

Notes

Only system errors are currently returned.