share/man/man3gss/gss_release_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_RELEASE_OID_SET 3GSS "Jan 15, 2003"
   7 .SH NAME
   8 gss_release_oid_set \- free storage associated with a GSS-API-generated
   9 gss_OID_set object
  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_release_oid_set\fR(\fBOM_uint32  *\fR\fIminor_status\fR, \fBgss_OID_set  *\fR\fIset\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBgss_release_oid_set()\fR function frees storage associated with a
  23 \fBGSS-API\fR-generated \fBgss_OID_set\fR object. The \fIset\fR parameter must
  24 refer to an \fBOID\fR-set that was returned from a \fBGSS-API\fR function. The
  25 \fBgss_release_oid_set()\fR function will free the storage associated with each
  26 individual member \fBOID\fR, the \fBOID\fR \fIset\fR's elements array, and
  27 \fBgss_OID_set_desc\fR.
  28 .sp
  29 .LP
  30 \fBgss_OID_set\fR is set to \fBGSS_C_NO_OID_SET\fR on successful completion of
  31 this function.
  32 .SH PARAMETERS
  33 .sp
  34 .LP
  35 The parameter descriptions for \fBgss_release_oid_set()\fR follow:
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIminor_status\fR\fR
  40 .ad
  41 .RS 16n
  42 A mechanism-specific status code
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fIset\fR\fR
  49 .ad
  50 .RS 16n
  51 Storage associated with the \fBgss_OID_set\fR will be deleted
  52 .RE
  53
  54 .SH ERRORS
  55 .sp
  56 .LP
  57 The \fBgss_release_oid_set()\fR function may return the following status codes:
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBGSS_S_COMPLETE\fR\fR
  62 .ad
  63 .RS 18n
  64 Successful completion
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBGSS_S_FAILURE\fR\fR
  71 .ad
  72 .RS 18n
  73 The underlying mechanism detected an error for which no specific \fBGSS\fR
  74 status code is defined.  The mechanism-specific status code reported by means
  75 of the \fIminor_status\fR parameter details the error condition.
  76 .RE
  77
  78 .SH ATTRIBUTES
  79 .sp
  80 .LP
  81 See \fBattributes\fR(5)  for descriptions of the following attributes:
  82 .sp
  83
  84 .sp
  85 .TS
  86 box;
  87 c | c
  88 l | l .
  89 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  90 _
  91 MT-Level        Safe
  92 .TE
  93
  94 .SH SEE ALSO
  95 .sp
  96 .LP
  97 \fBattributes\fR(5)
  98 .sp
  99 .LP
 100 \fISolaris Security for Developers Guide\fR