components/krb5/Solaris/man/gss_inquire_names_for_mech.3gss
changeset 5490 9bf0bc57423a
child 7820 a2b9a7de9e1a
equal deleted inserted replaced
5489:a5031bb8b66d 5490:9bf0bc57423a
       
     1 '\" te
       
     2 .\" Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
       
     3 .TH gss_inquire_names_for_mech 3GSS "22 Aug 2011" "SunOS 5.12" "Generic Security Services API Library Functions"
       
     4 .SH NAME
       
     5 gss_inquire_names_for_mech \- list the name-types supported by the specified mechanism
       
     6 .SH SYNOPSIS
       
     7 .LP
       
     8 .nf
       
     9 \fBcc\fR [\fIflag \&.\|.\|.\fR] \fIfile\fR\&.\|.\|. \fB-lgss\fR [\fIlibrary \&.\|.\|.\fR] 
       
    10 #include <gssapi/gssapi.h>
       
    11 
       
    12 \fBOM_uint32\fR \fBgss_inquire_names_for_mech\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
       
    13      \fBconst gss_OID\fR \fImechanism\fR,\fBgss_OID_set *\fR\fIname_types\fR);
       
    14 .fi
       
    15 
       
    16 .SH DESCRIPTION
       
    17 .sp
       
    18 .LP
       
    19 The \fBgss_inquire_names_for_mech()\fR function returns the set of name-types supported by the specified mechanism.
       
    20 .SH PARAMETERS
       
    21 .sp
       
    22 .LP
       
    23 The parameter descriptions for \fBgss_inquire_names_for_mech()\fR follow:
       
    24 .sp
       
    25 .ne 2
       
    26 .mk
       
    27 .na
       
    28 \fB\fIminor_status\fR\fR
       
    29 .ad
       
    30 .RS 16n
       
    31 .rt  
       
    32 A mechanism-specific status code.
       
    33 .RE
       
    34 
       
    35 .sp
       
    36 .ne 2
       
    37 .mk
       
    38 .na
       
    39 \fB\fImechanism\fR\fR
       
    40 .ad
       
    41 .RS 16n
       
    42 .rt  
       
    43 The mechanism to be interrogated.
       
    44 .RE
       
    45 
       
    46 .sp
       
    47 .ne 2
       
    48 .mk
       
    49 .na
       
    50 \fB\fIname_types\fR\fR
       
    51 .ad
       
    52 .RS 16n
       
    53 .rt  
       
    54 Set of name-types supported by the specified mechanism.  The returned \fBOID\fR set must be freed by the application after use with a call to \fBgss_release_oid_set\fR(3GSS).
       
    55 .RE
       
    56 
       
    57 .SH ERRORS
       
    58 .sp
       
    59 .LP
       
    60 The \fBgss_inquire_names_for_mech()\fR function may return the following values:
       
    61 .sp
       
    62 .ne 2
       
    63 .mk
       
    64 .na
       
    65 \fB\fBGSS_S_COMPLETE\fR\fR
       
    66 .ad
       
    67 .RS 18n
       
    68 .rt  
       
    69 Successful completion.
       
    70 .RE
       
    71 
       
    72 .sp
       
    73 .ne 2
       
    74 .mk
       
    75 .na
       
    76 \fB\fBGSS_S_FAILURE\fR\fR
       
    77 .ad
       
    78 .RS 18n
       
    79 .rt  
       
    80 The underlying mechanism detected an error for which no specific \fBGSS\fR status code is defined.  The mechanism-specific status code reported by means 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 tab() box;
       
    92 cw(2.75i) |cw(2.75i) 
       
    93 lw(2.75i) |lw(2.75i) 
       
    94 .
       
    95 ATTRIBUTE TYPEATTRIBUTE VALUE
       
    96 _
       
    97 MT-LevelSafe
       
    98 .TE
       
    99 
       
   100 .SH SEE ALSO
       
   101 .sp
       
   102 .LP
       
   103 \fBgss_release_oid_set\fR(3GSS), \fBattributes\fR(5)
       
   104 .sp
       
   105 .LP
       
   106