summaryrefslogtreecommitdiff
path: root/usr/src/man/man3gss/gss_release_oid.3gss
diff options
context:
space:
mode:
authorRichard Lowe <richlowe@richlowe.net>2011-03-14 14:05:30 -0400
committerRichard Lowe <richlowe@richlowe.net>2011-03-14 14:05:30 -0400
commitc10c16dec587a0662068f6e2991c29ed3a9db943 (patch)
treef414286f4bba41d75683ed4fbbaa6bfa4bf7fabd /usr/src/man/man3gss/gss_release_oid.3gss
parent68caef18a23a498d9e3017b983562c0f4fd8ab23 (diff)
downloadillumos-gate-c10c16dec587a0662068f6e2991c29ed3a9db943.tar.gz
243 system manual pages should live with the software
Reviewed by: garrett@nexenta.com Reviewed by: gwr@nexenta.com Reviewed by: trisk@opensolaris.org Approved by: gwr@nexenta.com --HG-- extra : rebase_source : 0c599d0bec0dc8865fbba67721a7a6cd6b1feefb
Diffstat (limited to 'usr/src/man/man3gss/gss_release_oid.3gss')
-rw-r--r--usr/src/man/man3gss/gss_release_oid.3gss114
1 files changed, 114 insertions, 0 deletions
diff --git a/usr/src/man/man3gss/gss_release_oid.3gss b/usr/src/man/man3gss/gss_release_oid.3gss
new file mode 100644
index 0000000000..707ba59cc2
--- /dev/null
+++ b/usr/src/man/man3gss/gss_release_oid.3gss
@@ -0,0 +1,114 @@
+'\" te
+.\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
+.\" 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.
+.\" 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.
+.\" 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]
+.TH gss_release_oid 3GSS "15 Jan 2003" "SunOS 5.11" "Generic Security Services API Library Functions"
+.SH NAME
+gss_release_oid \- release an object identifier
+.SH SYNOPSIS
+.LP
+.nf
+\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lgss\fR [ \fIlibrary\fR... ]
+#include <gssapi/gssapi.h>
+
+\fB\fR\fBgss_release_oid\fR(\fBOM_uint32 *\fR\fIminor_status\fR, \fBconst gss_OID *\fR\fIoid\fR);
+.fi
+
+.SH DESCRIPTION
+.sp
+.LP
+The \fBgss_release_oid()\fR function deletes an \fBOID\fR. Such an \fBOID\fR
+might have been created with \fBgss_str_to_oid()\fR.
+.sp
+.LP
+Since creating and deleting individual \fBOID\fRs is discouraged, it is
+preferable to use \fBgss_release_oid_set()\fR if it is necessary to deallocate
+a set of \fBOID\fRs.
+.SH PARAMETERS
+.sp
+.LP
+The parameter descriptions for \fBgss_release_oid()\fR are as follows:
+.sp
+.ne 2
+.mk
+.na
+\fB\fIminor_status\fR\fR
+.ad
+.RS 16n
+.rt
+A mechanism-specific status code.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIoid\fR\fR
+.ad
+.RS 16n
+.rt
+The object identifier of the mechanism to be deleted.
+.RE
+
+.SH ERRORS
+.sp
+.LP
+\fBgss_release_oid()\fR returns one of the following status codes:
+.sp
+.ne 2
+.mk
+.na
+\fB\fBGSS_S_COMPLETE\fR\fR
+.ad
+.RS 18n
+.rt
+Successful completion.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBGSS_S_FAILURE\fR\fR
+.ad
+.RS 18n
+.rt
+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.
+.RE
+
+.SH ATTRIBUTES
+.sp
+.LP
+See \fBattributes\fR(5) for descriptions of the following attributes:
+.sp
+
+.sp
+.TS
+tab() box;
+cw(2.75i) |cw(2.75i)
+lw(2.75i) |lw(2.75i)
+.
+ATTRIBUTE TYPEATTRIBUTE VALUE
+_
+MT LevelSafe
+.TE
+
+.SH SEE ALSO
+.sp
+.LP
+\fBgss_release_oid_set\fR(3GSS), \fBgss_str_to_oid\fR(3GSS),
+\fBattributes\fR(5)
+.sp
+.LP
+\fISolaris Security for Developers Guide\fR
+.SH WARNINGS
+.sp
+.LP
+This function is included for compatibility only with programs using earlier
+versions of the \fBGSS-API\fR and should not be used for new programs. Other
+implementations of the \fBGSS-API\fR might not support this function, so
+portable programs should not rely on it. Sun might not continue to support this
+function.