xref: /titanic_51/usr/src/man/man3gss/gss_release_buffer.3gss (revision c10c16dec587a0662068f6e2991c29ed3a9db943)
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]
gss_release_buffer 3GSS "15 Jan 2003" "SunOS 5.11" "Generic Security Services API Library Functions"
NAME
gss_release_buffer - free buffer storage allocated by a GSS-API function
SYNOPSIS

cc [ flag... ] file... -lgss [ library... ] 
#include <gssapi/gssapi.h>

OM_uint32 gss_release_buffer(OM_uint32 *minor_status, gss_buffer_tbuffer);
DESCRIPTION

The gss_release_buffer() function frees buffer storage allocated by a GSS-API function. The gss_release_buffer() function also zeros the length field in the descriptor to which the buffer parameter refers, while the GSS-API function sets the pointer field in the descriptor to NULL. Any buffer object returned by a GSS-API function may be passed to gss_release_buffer(), even if no storage is associated with the buffer.

PARAMETERS

The parameter descriptions for gss_release_buffer() follow:

minor_status

Mechanism-specific status code.

buffer

The storage associated with the buffer will be deleted. The gss_buffer_desc() object will not be freed; however, its length field will be zeroed.

ERRORS

The gss_release_buffer() function may return the following status codes:

GSS_S_COMPLETE

Successful completion

GSS_S_FAILURE

The underlying mechanism detected an error for which no specific GSS status code is defined. The mechanism-specific status code reported by means of the minor_status parameter details the error condition.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
MT-LevelSafe
SEE ALSO

attributes(5)

Solaris Security for Developers Guide