share/man/man3gss/gss_create_empty_oid_set.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_CREATE_EMPTY_OID_SET 3GSS "Jan 14, 2003"
   7 .SH NAME
   8 gss_create_empty_oid_set \- create an object-identifier set containing no
   9 object identifiers
  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_create_empty_oid_set\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
  17      \fBgss_OID_set *\fR\fIoid_set\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBgss_create_empty_oid_set()\fR function creates an object-identifier set
  24 containing no object identifiers to which members may be subsequently added
  25 using the \fBgss_add_oid_set_member\fR(3GSS) function.  These functions can be
  26 used to construct sets of mechanism object identifiers for input to
  27 \fBgss_acquire_cred\fR(3GSS).
  28 .SH PARAMETERS
  29 .sp
  30 .LP
  31 The parameter descriptions for \fBgss_create_empty_oid_set()\fR follow:
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIminor_status\fR\fR
  36 .ad
  37 .RS 16n
  38 Mechanism-specific status code
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fIoid_set\fR\fR
  45 .ad
  46 .RS 16n
  47 Empty object identifier set. The function will allocate the
  48 \fBgss_OID_set_desc\fR object, which the  application must free after use with
  49 a call to \fBgss_release_oid_set\fR(3GSS).
  50 .RE
  51
  52 .SH ERRORS
  53 .sp
  54 .LP
  55 The \fBgss_create_empty_oid_set()\fR function may return the following status
  56 codes:
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBGSS_S_COMPLETE\fR\fR
  61 .ad
  62 .RS 18n
  63 Successful completion
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBGSS_S_FAILURE\fR\fR
  70 .ad
  71 .RS 18n
  72 The underlying mechanism detected an error for which no specific \fBGSS\fR
  73 status code is defined.  The mechanism-specific status code reported by means
  74 of the \fIminor_status\fR parameter details the error condition.
  75 .RE
  76
  77 .SH ATTRIBUTES
  78 .sp
  79 .LP
  80 See \fBattributes\fR(5)  for descriptions of the following attributes:
  81 .sp
  82
  83 .sp
  84 .TS
  85 box;
  86 c | c
  87 l | l .
  88 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  89 _
  90 MT-Level        Safe
  91 .TE
  92
  93 .SH SEE ALSO
  94 .sp
  95 .LP
  96 \fBgss_acquire_cred\fR(3GSS), \fBgss_add_oid_set_member\fR(3GSS),
  97 \fBgss_release_oid_set\fR(3GSS), \fBattributes\fR(5)
  98 .sp
  99 .LP
 100 \fISolaris Security for Developers Guide\fR