summaryrefslogtreecommitdiff
path: root/usr/src/man/man3gss/gss_release_name.3gss
blob: 0693caed06f9bb97972a31ee720c2ec6278d6de8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
'\" 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_NAME 3GSS "June 18, 2021"
.SH NAME
gss_release_name \- discard an internal-form name
.SH SYNOPSIS
.nf
\fBcc\fR [\fIflag \&.\|.\|.\fR] \fIfile\fR\&.\|.\|. \fB-lgss\fR [\fIlibrary \&.\|.\|.\fR]
#include <gssapi/gssapi.h>

\fBOM_uint32\fR \fBgss_release_name\fR(\fBOM_uint32 *\fR\fIminor_status\fR, \fBgss_name_t *\fR\fIname\fR);
.fi

.SH DESCRIPTION
The \fBgss_release_name()\fR function frees \fBGSS-API\fR-allocated storage
associated with an internal-form name.  The \fIname\fR is set to
\fBGSS_C_NO_NAME\fR on successful completion of this call.
.SH PARAMETERS
The parameter descriptions for \fBgss_release_name()\fR follow:
.sp
.ne 2
.na
\fB\fIminor_status\fR\fR
.ad
.RS 16n
A mechanism-specific status code.
.RE

.sp
.ne 2
.na
\fB\fIname\fR\fR
.ad
.RS 16n
The name to be deleted.
.RE

.SH ERRORS
The \fBgss_release_name()\fR function may return the following status codes:
.sp
.ne 2
.na
\fB\fBGSS_S_COMPLETE\fR\fR
.ad
.RS 18n
Successful completion.
.RE

.sp
.ne 2
.na
\fB\fBGSS_S_BAD_NAME\fR\fR
.ad
.RS 18n
The \fIname\fR parameter did not contain a valid name.
.RE

.sp
.ne 2
.na
\fB\fBGSS_S_FAILURE\fR\fR
.ad
.RS 18n
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
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
MT-Level	Safe
.TE

.SH SEE ALSO
\fBattributes\fR(5)
.sp
.LP
\fISolaris Security for Developers Guide\fR