share/man/man3gss/gss_add_oid_set_member.3gss

   1 '\" te
   2 .\" Copyright (c) 2007, 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_ADD_OID_SET_MEMBER 3GSS "Aug 16, 2007"
   7 .SH NAME
   8 gss_add_oid_set_member \- add an object identifier to an object identifier set
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lgss\fR  [ \fIlibrary\fR... ]
  13 #include <gssapi/gssapi.h>
  14
  15 \fBOM_uint32\fR \fBgss_add_oid_set_member\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
  16      \fBconst gss_OID\fR \fImember_oid\fR, \fBgss_OID_set *\fR\fIoid_set\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .LP
  22 The parameter descriptions for \fBgss_add_oid_set_member()\fR follow:
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIminor_status\fR\fR
  27 .ad
  28 .RS 16n
  29 A mechanism specific status code.
  30 .RE
  31
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fImember_oid\fR\fR
  36 .ad
  37 .RS 16n
  38 Object identifier to be copied into the set.
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fIoid_set\fR\fR
  45 .ad
  46 .RS 16n
  47 Set in which the object identifier should be inserted.
  48 .RE
  49
  50 .SH DESCRIPTION
  51 .sp
  52 .LP
  53 The \fBgss_add_oid_set_member()\fR function adds an object identifier to an
  54 object identifier set. You should use this function in conjunction with
  55 \fBgss_create_empty_oid_set\fR(3GSS) when constructing a set of mechanism
  56 \fBOID\fRs for input to \fBgss_acquire_cred\fR(3GSS). The \fIoid_set\fR
  57 parameter must refer to an \fBOID\fR-set created by \fBGSS-API\fR, that is, a
  58 set returned by \fBgss_create_empty_oid_set\fR(3GSS).
  59 .sp
  60 .LP
  61 The \fBGSS-API\fR creates a copy of the \fImember_oid\fR and inserts this copy
  62 into the set, expanding the storage allocated to the \fBOID\fR-set elements
  63 array, if necessary.  New members are always added to the end of the OID set's
  64 elements. If the \fImember_oid\fR is already present, the \fIoid_set\fR should
  65 remain unchanged.
  66 .SH ERRORS
  67 .sp
  68 .LP
  69 The \fBgss_add_oid_set_member()\fR function can return the following status
  70 codes:
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBGSS_S_COMPLETE\fR\fR
  75 .ad
  76 .sp .6
  77 .RS 4n
  78 Successful completion.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBGSS_S_FAILURE\fR\fR
  85 .ad
  86 .sp .6
  87 .RS 4n
  88 The underlying mechanism detected an error for which no specific \fBGSS\fR
  89 status code is defined.  The mechanism-specific status code reported by means
  90 of the \fIminor_status\fR parameter details the error condition.
  91 .RE
  92
  93 .SH ATTRIBUTES
  94 .sp
  95 .LP
  96 See \fBattributes\fR(5)  for descriptions of the following attributes:
  97 .sp
  98
  99 .sp
 100 .TS
 101 box;
 102 c | c
 103 l | l .
 104 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 105 _
 106 MT-Level        Safe
 107 .TE
 108
 109 .SH SEE ALSO
 110 .sp
 111 .LP
 112 \fBgss_acquire_cred\fR(3GSS), \fBgss_create_empty_oid_set\fR(3GSS),
 113 \fBattributes\fR(5)
 114 .sp
 115 .LP
 116 \fISolaris Security for Developers Guide\fR