opensolaris man page for rpc_gss_get_error

rpc_gss_get_error(3NSL) 			       Networking Services Library Functions				   rpc_gss_get_error(3NSL)

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 defined for this function are

	 #define RPC_GSS_ER_SUCCESS	    0	 /* no error */
	 #define RPC_GSS_ER_SYSTEMERROR     1	 /* system error */

PARAMETERS
       Information on RPCSEC_GSS data types for parameters may be found on the rpcsec_gss(3NSL) man page.

       error	 A   rpc_gss_error_t  structure.   If the rpc_gss_error field is equal to  RPC_GSS_ER_SYSTEMERROR, the	system_error field will be
		 set to the value of errno.

RETURN VALUES
       Unless there is a failure indication from an invoked RPCSEC_GSS function,  rpc_gss_get_error() does not set error to a meaningful value.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWrsg (32-bit)		   |
       +-----------------------------+-----------------------------+
       |			     |SUNWrsgx (64-bit) 	   |
       +-----------------------------+-----------------------------+

SEE ALSO
       perror(3C), rpc(3NSL), rpcsec_gss(3NSL), attributes(5)

       ONC+ Developer's Guide

       Linn, J. RFC 2078, Generic Security Service Application Program Interface, Version 2. Network Working Group. January 1997.

NOTES
       Only system errors are currently returned.

SunOS 5.11							    5 Feb 2002						   rpc_gss_get_error(3NSL)