usr/src/man/man3gss/gss_release_buffer.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_BUFFER 3GSS "Jan 15, 2003"
   7 .SH NAME
   8 gss_release_buffer \- free buffer storage allocated by a GSS-API function
   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_buffer\fR(\fBOM_uint32 *\fR\fIminor_status\fR, \fBgss_buffer_t\fR\fIbuffer\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21  The \fBgss_release_buffer()\fR function frees buffer storage allocated by a
  22 \fBGSS-API\fR function. The \fBgss_release_buffer()\fR function also zeros the
  23 length field in the descriptor to which the buffer parameter refers, while the
  24 \fBGSS-API\fR function sets the pointer field in the descriptor to \fBNULL\fR.
  25 Any buffer object returned by a \fBGSS-API\fR function may be passed to
  26 \fBgss_release_buffer()\fR, even if no storage is associated with the buffer.
  27 .SH PARAMETERS
  28 .sp
  29 .LP
  30 The parameter descriptions for \fBgss_release_buffer()\fR follow:
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fIminor_status\fR\fR
  35 .ad
  36 .RS 16n
  37 Mechanism-specific status code.
  38 .RE
  39
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fIbuffer\fR\fR
  44 .ad
  45 .RS 16n
  46 The storage associated with the buffer will be deleted.  The
  47 \fBgss_buffer_desc()\fR object will not be freed; however, its length field
  48 will be zeroed.
  49 .RE
  50
  51 .SH ERRORS
  52 .sp
  53 .LP
  54 The \fBgss_release_buffer()\fR function may return the following status codes:
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBGSS_S_COMPLETE\fR\fR
  59 .ad
  60 .RS 18n
  61 Successful completion
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBGSS_S_FAILURE\fR\fR
  68 .ad
  69 .RS 18n
  70 The underlying mechanism detected an error for which no specific \fBGSS\fR
  71 status code is defined.  The mechanism-specific status code reported by means
  72 of the \fIminor_status\fR parameter details the error condition.
  73 .RE
  74
  75 .SH ATTRIBUTES
  76 .sp
  77 .LP
  78 See \fBattributes\fR(5)  for descriptions of the following attributes:
  79 .sp
  80
  81 .sp
  82 .TS
  83 box;
  84 c | c
  85 l | l .
  86 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  87 _
  88 MT-Level        Safe
  89 .TE
  90
  91 .SH SEE ALSO
  92 .sp
  93 .LP
  94 \fBattributes\fR(5)
  95 .sp
  96 .LP
  97 \fISolaris Security for Developers Guide\fR