usr/src/man/man3gss/gss_release_oid.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 3GSS "Jan 15, 2003"
   7 .SH NAME
   8 gss_release_oid \- release an object identifier
   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 \fB\fR\fBgss_release_oid\fR(\fBOM_uint32 *\fR\fIminor_status\fR, \fBconst gss_OID *\fR\fIoid\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBgss_release_oid()\fR function deletes an \fBOID\fR. Such an \fBOID\fR
  22 might have been created with \fBgss_str_to_oid()\fR.
  23 .sp
  24 .LP
  25 Since creating and deleting individual \fBOID\fRs is discouraged, it is
  26 preferable to use \fBgss_release_oid_set()\fR if it is necessary to deallocate
  27 a set of \fBOID\fRs.
  28 .SH PARAMETERS
  29 .sp
  30 .LP
  31 The parameter descriptions for \fBgss_release_oid()\fR are as follows:
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIminor_status\fR\fR
  36 .ad
  37 .RS 16n
  38 A mechanism-specific status code.
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fIoid\fR\fR
  45 .ad
  46 .RS 16n
  47 The object identifier of the mechanism to be deleted.
  48 .RE
  49
  50 .SH ERRORS
  51 .sp
  52 .LP
  53 \fBgss_release_oid()\fR returns one of the following status codes:
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBGSS_S_COMPLETE\fR\fR
  58 .ad
  59 .RS 18n
  60 Successful completion.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBGSS_S_FAILURE\fR\fR
  67 .ad
  68 .RS 18n
  69 The underlying mechanism detected an error for which no specific \fBGSS\fR
  70 status code is defined.  The mechanism-specific status code reported by means
  71 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 box;
  83 c | c
  84 l | l .
  85 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  86 _
  87 MT Level        Safe
  88 .TE
  89
  90 .SH SEE ALSO
  91 .sp
  92 .LP
  93 \fBgss_release_oid_set\fR(3GSS), \fBgss_str_to_oid\fR(3GSS),
  94 \fBattributes\fR(5)
  95 .sp
  96 .LP
  97 \fISolaris Security for Developers Guide\fR
  98 .SH WARNINGS
  99 .sp
 100 .LP
 101 This function is included for compatibility only with programs using earlier
 102 versions of the \fBGSS-API\fR and should not be used for new programs. Other
 103 implementations of the \fBGSS-API\fR might not support this function, so
 104 portable programs should not rely on it. Sun might not continue to support this
 105 function.