usr/src/man/man3nsl/rpc_gss_get_error.3nsl

   1 '\" te
   2 .\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH RPC_GSS_GET_ERROR 3NSL "Feb 5, 2002"
   7 .SH NAME
   8 rpc_gss_get_error \- get error codes on failure
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <rpc/rpcsec_gss.h>
  13
  14 \fBbool_t\fR \fBrpc_gss_get_error\fR(\fBrpc_gss_error_t\fR\fI*error\fR);
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 \fBrpc_gss_get_error()\fR fetches an error code when an \fBRPCSEC_GSS\fR
  21 routine fails.
  22 .sp
  23 .LP
  24 \fBrpc_gss_get_error()\fR uses a \fBrpc_gss_error_t\fR structure of the
  25 following form:
  26 .sp
  27 .in +2
  28 .nf
  29 typedef struct {
  30 int     rpc_gss_error;          \fIRPCSEC_GSS error\fR
  31 int     system_error;           \fIsystem error\fR
  32 } rpc_gss_error_t;
  33 .fi
  34 .in -2
  35
  36 .sp
  37 .LP
  38 Currently the only error codes defined for this function are
  39 .sp
  40 .in +2
  41 .nf
  42 #define RPC_GSS_ER_SUCCESS              0       /* no error */
  43 #define RPC_GSS_ER_SYSTEMERROR  1       /* system error */
  44 .fi
  45 .in -2
  46
  47 .SH PARAMETERS
  48 .sp
  49 .LP
  50 Information on \fBRPCSEC_GSS\fR data types for parameters may be found on the
  51 \fBrpcsec_gss\fR(3NSL) man page.
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBerror\fR \fR
  56 .ad
  57 .RS 10n
  58 A  \fBrpc_gss_error_t\fR structure.  If the \fBrpc_gss_error\fR field is equal
  59 to  \fBRPC_GSS_ER_SYSTEMERROR,\fR the  \fBsystem_error\fR field will be set to
  60 the value of \fBerrno\fR.
  61 .RE
  62
  63 .SH RETURN VALUES
  64 .sp
  65 .LP
  66 Unless there is a failure indication from an invoked \fBRPCSEC_GSS\fR function,
  67 \fBrpc_gss_get_error()\fR does not set \fBerror\fR to a meaningful value.
  68 .SH ATTRIBUTES
  69 .sp
  70 .LP
  71 See \fBattributes\fR(5) for descriptions of the following attributes:
  72 .sp
  73
  74 .sp
  75 .TS
  76 box;
  77 c | c
  78 l | l .
  79 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  80 _
  81 MT-Level        MT-Safe
  82 .TE
  83
  84 .SH SEE ALSO
  85 .sp
  86 .LP
  87 \fBperror\fR(3C), \fBrpc\fR(3NSL), \fBrpcsec_gss\fR(3NSL), \fBattributes\fR(5)
  88 .sp
  89 .LP
  90 \fIONC+ Developer\&'s Guide\fR
  91 .sp
  92 .LP
  93 Linn, J. \fIRFC 2078, Generic Security Service Application Program Interface, Version 2\fR. Network Working Group. January 1997.
  94 .SH NOTES
  95 .sp