usr/src/man/man3gss/gss_release_name.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_NAME 3GSS "Jan 15, 2003"
   7 .SH NAME
   8 gss_release_name \- discard an internal-form name
   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 \fBOM_uint32\fR \fBgss_release_name\fR(\fBOM_uint32 *\fR\fIminor_status\fR, \fBgss_name_t *\fR\fIname\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBgss_release_name()\fR function frees \fBGSS-API\fR-allocated storage
  22 associated with an internal-form name.  The \fIname\fR is set to
  23 \fBGSS_C_NO_NAME\fR on successful completion of this call.
  24 .SH PARAMETERS
  25 .sp
  26 .LP
  27 The parameter descriptions for \fBgss_release_name()\fR follow:
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIminor_status\fR\fR
  32 .ad
  33 .RS 16n
  34 A mechanism-specific status code.
  35 .RE
  36
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fIname\fR\fR
  41 .ad
  42 .RS 16n
  43 The name to be deleted.
  44 .RE
  45
  46 .SH ERRORS
  47 .sp
  48 .LP
  49 The \fBgss_release_name()\fR function may return the following status codes:
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBGSS_S_COMPLETE\fR\fR
  54 .ad
  55 .RS 18n
  56 Successful completion.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBGSS_S_BAD_NAME\fR\fR
  63 .ad
  64 .RS 18n
  65 The \fIname\fR parameter did not contain a valid name.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBGSS_S_FAILURE\fR\fR
  72 .ad
  73 .RS 18n
  74 The underlying mechanism detected an error for which no specific \fBGSS\fR
  75 status code is defined.  The mechanism-specific status code reported by means
  76 of the \fIminor_status\fR parameter details the error condition.
  77 .RE
  78
  79 .SH ATTRIBUTES
  80 .sp
  81 .LP
  82 See \fBattributes\fR(5) for descriptions of the following attributes:
  83 .sp
  84
  85 .sp
  86 .TS
  87 box;
  88 c | c
  89 l | l .
  90 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  91 _
  92 MT-Level        Safe
  93 .TE
  94
  95 .SH SEE ALSO
  96 .sp
  97 .LP
  98 \fBattributes\fR(5)
  99 .sp
 100 .LP
 101 \fISolaris Security for Developers Guide\fR