1 '\" te

     2 .\" Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.

     3 .TH gss_release_oid_set 3GSS "22 Aug 2011" "SunOS 5.12" "Generic Security Services API Library Functions"

     4 .SH NAME

     5 gss_release_oid_set \- free storage associated with a GSS-API-generated gss_OID_set object

     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_release_oid_set\fR(\fBOM_uint32  *\fR\fIminor_status\fR, \fBgss_OID_set  *\fR\fIset\fR);

    13 .fi

    14 

    15 .SH DESCRIPTION

    16 .sp

    17 .LP

    18 The \fBgss_release_oid_set()\fR function frees storage associated with a \fBGSS-API\fR-generated \fBgss_OID_set\fR object. The \fIset\fR parameter must refer to an \fBOID\fR-set that was returned from a \fBGSS-API\fR function. The \fBgss_release_oid_set()\fR function will free the storage associated with each individual member \fBOID\fR, the \fBOID\fR \fIset\fR's elements array, and \fBgss_OID_set_desc\fR.

    19 .sp

    20 .LP

    21 \fBgss_OID_set\fR is set to \fBGSS_C_NO_OID_SET\fR on successful completion of this function.

    22 .SH PARAMETERS

    23 .sp

    24 .LP

    25 The parameter descriptions for \fBgss_release_oid_set()\fR follow:

    26 .sp

    27 .ne 2

    28 .mk

    29 .na

    30 \fB\fIminor_status\fR\fR

    31 .ad

    32 .RS 16n

    33 .rt  

    34 A mechanism-specific status code

    35 .RE

    36 

    37 .sp

    38 .ne 2

    39 .mk

    40 .na

    41 \fB\fIset\fR\fR

    42 .ad

    43 .RS 16n

    44 .rt  

    45 Storage associated with the \fBgss_OID_set\fR will be deleted 

    46 .RE

    47 

    48 .SH ERRORS

    49 .sp

    50 .LP

    51 The \fBgss_release_oid_set()\fR function may return the following status codes:

    52 .sp

    53 .ne 2

    54 .mk

    55 .na

    56 \fB\fBGSS_S_COMPLETE\fR\fR

    57 .ad

    58 .RS 18n

    59 .rt  

    60 Successful completion

    61 .RE

    62 

    63 .sp

    64 .ne 2

    65 .mk

    66 .na

    67 \fB\fBGSS_S_FAILURE\fR\fR

    68 .ad

    69 .RS 18n

    70 .rt  

    71 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.

    72 .RE

    73 

    74 .SH ATTRIBUTES

    75 .sp

    76 .LP

    77 See \fBattributes\fR(5)  for descriptions of the following attributes:

    78 .sp

    79 

    80 .sp

    81 .TS

    82 tab() box;

    83 cw(2.75i) |cw(2.75i) 

    84 lw(2.75i) |lw(2.75i) 

    85 .

    86 ATTRIBUTE TYPEATTRIBUTE VALUE

    87 _

    88 MT-LevelSafe

    89 .TE

    90 

    91 .SH SEE ALSO

    92 .sp

    93 .LP

    94 \fBattributes\fR(5)

    95 .sp

    96 .LP

    97