components/krb5/Solaris/man/gss_test_oid_set_member.3gss
author Rich Burridge <rich.burridge@oracle.com>
Fri, 31 Mar 2017 07:26:17 -0700
changeset 7820 a2b9a7de9e1a
parent 5490 9bf0bc57423a
permissions -rw-r--r--
25795430 Adjust Userland man pages to "5.11" (from "5.12") where needed

'\" te
.\" Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
.TH gss_test_oid_set_member 3GSS "22 Aug 2011" "SunOS 5.11" "Generic Security Services API Library Functions"
.SH NAME
gss_test_oid_set_member \- interrogate an object identifier set
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lgss\fR  [ \fIlibrary\fR... ] 
#include <gssapi/gssapi.h>

\fBOM_uint32\fR \fBgss_test_oid_set_member\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
     \fBconst gss_OID\fR \fImember\fR,\fBconst gss_OID_set\fR \fIset\fR,
     \fBint *\fR\fIpresent\fR);
.fi

.SH DESCRIPTION
.sp
.LP
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.
.SH PARAMETERS
.sp
.LP
The parameter descriptions for \fBgss_test_oid_set_member()\fR follow:
.sp
.ne 2
.mk
.na
\fB\fIminor_status\fR\fR
.ad
.RS 16n
.rt  
A mechanism-specific status code
.RE

.sp
.ne 2
.mk
.na
\fB\fImember\fR\fR
.ad
.RS 16n
.rt  
An object identifier whose presence is to be tested
.RE

.sp
.ne 2
.mk
.na
\fB\fIset\fR\fR
.ad
.RS 16n
.rt  
An object identifier set.
.RE

.sp
.ne 2
.mk
.na
\fB\fIpresent\fR\fR
.ad
.RS 16n
.rt  
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. 
.RE

.SH ERRORS
.sp
.LP
The \fBgss_test_oid_set_member()\fR function may return the following status codes:
.sp
.ne 2
.mk
.na
\fB\fBGSS_S_COMPLETE\fR\fR
.ad
.RS 18n
.rt  
Successful completion
.RE

.sp
.ne 2
.mk
.na
\fB\fBGSS_S_FAILURE\fR\fR
.ad
.RS 18n
.rt  
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.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5)  for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
MT-LevelSafe
.TE

.SH SEE ALSO
.sp
.LP
\fBgss_acquire_cred\fR(3GSS), \fBgss_indicate_mechs\fR(3GSS), \fBgss_inquire_cred\fR(3GSS), \fBattributes\fR(5)
.sp
.LP