xref: /illumos-gate/usr/src/man/man3nsl/rpc_gss_get_error.3nsl (revision d48be21240dfd051b689384ce2b23479d757f2d8)
te
Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
RPC_GSS_GET_ERROR 3NSL "Feb 5, 2002"
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(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level MT-Safe
SEE ALSO

perror (3C), rpc (3NSL), rpcsec_gss (3NSL), attributes (7)

ONC+ Developer's Guide

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

NOTES