usr/src/man/man3gss/gss_inquire_names_for_mech.3gss

   1 '\" te
   2 .\" Copyright (C) 2003, 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 GSS_INQUIRE_NAMES_FOR_MECH 3GSS "Jan 15, 2003"
   7 .SH NAME
   8 gss_inquire_names_for_mech \- list the name-types supported by the specified
   9 mechanism
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [\fIflag \&.\|.\|.\fR] \fIfile\fR\&.\|.\|. \fB-lgss\fR [\fIlibrary \&.\|.\|.\fR]
  14 #include <gssapi/gssapi.h>
  15
  16 \fBOM_uint32\fR \fBgss_inquire_names_for_mech\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
  17      \fBconst gss_OID\fR \fImechanism\fR,\fBgss_OID_set *\fR\fIname_types\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBgss_inquire_names_for_mech()\fR function returns the set of name-types
  24 supported by the specified mechanism.
  25 .SH PARAMETERS
  26 .sp
  27 .LP
  28 The parameter descriptions for \fBgss_inquire_names_for_mech()\fR follow:
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIminor_status\fR\fR
  33 .ad
  34 .RS 16n
  35 A mechanism-specific status code.
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fImechanism\fR\fR
  42 .ad
  43 .RS 16n
  44 The mechanism to be interrogated.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fIname_types\fR\fR
  51 .ad
  52 .RS 16n
  53 Set of name-types supported by the specified mechanism.  The returned \fBOID\fR
  54 set must be freed by the application after use with a call to
  55 \fBgss_release_oid_set\fR(3GSS).
  56 .RE
  57
  58 .SH ERRORS
  59 .sp
  60 .LP
  61 The \fBgss_inquire_names_for_mech()\fR function may return the following
  62 values:
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBGSS_S_COMPLETE\fR\fR
  67 .ad
  68 .RS 18n
  69 Successful completion.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBGSS_S_FAILURE\fR\fR
  76 .ad
  77 .RS 18n
  78 The underlying mechanism detected an error for which no specific \fBGSS\fR
  79 status code is defined.  The mechanism-specific status code reported by means
  80 of the \fIminor_status\fR parameter details the error condition.
  81 .RE
  82
  83 .SH ATTRIBUTES
  84 .sp
  85 .LP
  86 See \fBattributes\fR(5) for descriptions of the following attributes:
  87 .sp
  88
  89 .sp
  90 .TS
  91 box;
  92 c | c
  93 l | l .
  94 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  95 _
  96 MT-Level        Safe
  97 .TE
  98
  99 .SH SEE ALSO
 100 .sp
 101 .LP
 102 \fBgss_release_oid_set\fR(3GSS), \fBattributes\fR(5)
 103 .sp
 104 .LP
 105 \fISolaris Security for Developers Guide\fR