components/krb5/Solaris/man/gss_release_buffer.3gss
changeset 5490 9bf0bc57423a
child 7820 a2b9a7de9e1a
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/components/krb5/Solaris/man/gss_release_buffer.3gss	Wed Feb 24 10:43:57 2016 -0600
@@ -0,0 +1,94 @@
+'\" te
+.\" Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
+.TH gss_release_buffer 3GSS "22 Aug 2011" "SunOS 5.12" "Generic Security Services API Library Functions"
+.SH NAME
+gss_release_buffer \- free buffer storage allocated by a GSS-API function
+.SH SYNOPSIS
+.LP
+.nf
+\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lgss\fR  [ \fIlibrary\fR... ] 
+#include <gssapi/gssapi.h>
+
+\fBOM_uint32\fR \fBgss_release_buffer\fR(\fBOM_uint32 *\fR\fIminor_status\fR, \fBgss_buffer_t\fR\fIbuffer\fR);
+.fi
+
+.SH DESCRIPTION
+.sp
+.LP
+ The \fBgss_release_buffer()\fR function frees buffer storage allocated by a \fBGSS-API\fR function. The \fBgss_release_buffer()\fR function also zeros the length field in the descriptor to which the buffer parameter refers, while the \fBGSS-API\fR function sets the pointer field in the descriptor to \fBNULL\fR. Any buffer object returned by a \fBGSS-API\fR function may be passed to \fBgss_release_buffer()\fR, even if no storage is associated with the buffer.
+.SH PARAMETERS
+.sp
+.LP
+The parameter descriptions for \fBgss_release_buffer()\fR follow:
+.sp
+.ne 2
+.mk
+.na
+\fB\fIminor_status\fR\fR
+.ad
+.RS 16n
+.rt  
+Mechanism-specific status code.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIbuffer\fR\fR
+.ad
+.RS 16n
+.rt  
+The storage associated with the buffer will be deleted.  The \fBgss_buffer_desc()\fR object will not be freed; however, its length field will be zeroed.
+.RE
+
+.SH ERRORS
+.sp
+.LP
+The \fBgss_release_buffer()\fR function may return 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
+\fBattributes\fR(5)
+.sp
+.LP
+