components/krb5/Solaris/man/gss_test_oid_set_member.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_test_oid_set_member 3GSS "22 Aug 2011" "SunOS 5.12" "Generic Security Services API Library Functions"
       
     4 .SH NAME
       
     5 gss_test_oid_set_member \- interrogate an object identifier set
       
     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_test_oid_set_member\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
       
    13      \fBconst gss_OID\fR \fImember\fR,\fBconst gss_OID_set\fR \fIset\fR,
       
    14      \fBint *\fR\fIpresent\fR);
       
    15 .fi
       
    16 
       
    17 .SH DESCRIPTION
       
    18 .sp
       
    19 .LP
       
    20 The \fBgss_test_oid_set_member()\fR function interrogates an object identifier set to determine if a specified object identifier is a member.  This function should be used with \fBOID\fR sets returned by \fBgss_indicate_mechs\fR(3GSS), \fBgss_acquire_cred\fR(3GSS), and \fBgss_inquire_cred\fR(3GSS), but it will also work with user-generated sets.
       
    21 .SH PARAMETERS
       
    22 .sp
       
    23 .LP
       
    24 The parameter descriptions for \fBgss_test_oid_set_member()\fR follow:
       
    25 .sp
       
    26 .ne 2
       
    27 .mk
       
    28 .na
       
    29 \fB\fIminor_status\fR\fR
       
    30 .ad
       
    31 .RS 16n
       
    32 .rt  
       
    33 A mechanism-specific status code
       
    34 .RE
       
    35 
       
    36 .sp
       
    37 .ne 2
       
    38 .mk
       
    39 .na
       
    40 \fB\fImember\fR\fR
       
    41 .ad
       
    42 .RS 16n
       
    43 .rt  
       
    44 An object identifier whose presence is to be tested
       
    45 .RE
       
    46 
       
    47 .sp
       
    48 .ne 2
       
    49 .mk
       
    50 .na
       
    51 \fB\fIset\fR\fR
       
    52 .ad
       
    53 .RS 16n
       
    54 .rt  
       
    55 An object identifier set.
       
    56 .RE
       
    57 
       
    58 .sp
       
    59 .ne 2
       
    60 .mk
       
    61 .na
       
    62 \fB\fIpresent\fR\fR
       
    63 .ad
       
    64 .RS 16n
       
    65 .rt  
       
    66 The value of \fIpresent\fR is non-zero if the specified \fBOID\fR is a member of the set; if not, the value of \fIpresent\fR is zero. 
       
    67 .RE
       
    68 
       
    69 .SH ERRORS
       
    70 .sp
       
    71 .LP
       
    72 The \fBgss_test_oid_set_member()\fR function may return the following status codes:
       
    73 .sp
       
    74 .ne 2
       
    75 .mk
       
    76 .na
       
    77 \fB\fBGSS_S_COMPLETE\fR\fR
       
    78 .ad
       
    79 .RS 18n
       
    80 .rt  
       
    81 Successful completion
       
    82 .RE
       
    83 
       
    84 .sp
       
    85 .ne 2
       
    86 .mk
       
    87 .na
       
    88 \fB\fBGSS_S_FAILURE\fR\fR
       
    89 .ad
       
    90 .RS 18n
       
    91 .rt  
       
    92 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.
       
    93 .RE
       
    94 
       
    95 .SH ATTRIBUTES
       
    96 .sp
       
    97 .LP
       
    98 See \fBattributes\fR(5)  for descriptions of the following attributes:
       
    99 .sp
       
   100 
       
   101 .sp
       
   102 .TS
       
   103 tab() box;
       
   104 cw(2.75i) |cw(2.75i) 
       
   105 lw(2.75i) |lw(2.75i) 
       
   106 .
       
   107 ATTRIBUTE TYPEATTRIBUTE VALUE
       
   108 _
       
   109 MT-LevelSafe
       
   110 .TE
       
   111 
       
   112 .SH SEE ALSO
       
   113 .sp
       
   114 .LP
       
   115 \fBgss_acquire_cred\fR(3GSS), \fBgss_indicate_mechs\fR(3GSS), \fBgss_inquire_cred\fR(3GSS), \fBattributes\fR(5)
       
   116 .sp
       
   117 .LP
       
   118