lib/libgssapi/gss_release_buffer.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2005 Doug Rabson
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\"     $FreeBSD$
  28 .\"
  29 .\" The following commands are required for all man pages.
  30 .Dd January 26, 2010
  31 .Dt GSS_RELEASE_BUFFER 3 PRM
  32 .Os
  33 .Sh NAME
  34 .Nm gss_release_buffer
  35 .Nd Discard a buffer
  36 .\" This next command is for sections 2 and 3 only.
  37 .\" .Sh LIBRARY
  38 .Sh SYNOPSIS
  39 .In "gssapi/gssapi.h"
  40 .Ft OM_uint32
  41 .Fo gss_release_buffer
  42 .Fa "OM_uint32 *minor_status"
  43 .Fa "gss_buffer_t buffer"
  44 .Fc
  45 .Sh DESCRIPTION
  46 Free storage associated with a buffer.
  47 The storage must have been allocated by a GSS-API routine.
  48 In addition to freeing the associated storage,
  49 the routine will zero the length field in the descriptor to which the
  50 buffer parameter refers,
  51 and implementations are encouraged to additionally set the pointer
  52 field in the descriptor to
  53 .Dv NULL .
  54 Any buffer object returned by a GSS-API routine may be passed to
  55 .Fn gss_release_buffer
  56 (even if there is no storage associated with the buffer).
  57 .Sh PARAMETERS
  58 .Bl -tag -width ".It minor_status"
  59 .It minor_status
  60 Mechanism specific status code.
  61 .It buffer
  62 The storage associated with the buffer will be deleted.
  63 The gss_buffer_desc object will not be freed,
  64 but its length field will be zeroed.
  65 .El
  66 .Sh RETURN VALUES
  67 .Bl -tag -width ".It GSS_S_COMPLETE"
  68 .It GSS_S_COMPLETE
  69 Successful completion
  70 .El
  71 .Sh STANDARDS
  72 .Bl -tag -width ".It RFC 2743"
  73 .It RFC 2743
  74 Generic Security Service Application Program Interface Version 2, Update 1
  75 .It RFC 2744
  76 Generic Security Service API Version 2 : C-bindings
  77 .El
  78 .Sh HISTORY
  79 The
  80 .Nm
  81 function first appeared in
  82 .Fx 7.0 .
  83 .Sh AUTHORS
  84 John Wray, Iris Associates
  85 .Sh COPYRIGHT
  86 Copyright (C) The Internet Society (2000).  All Rights Reserved.
  87 .Pp
  88 This document and translations of it may be copied and furnished to
  89 others, and derivative works that comment on or otherwise explain it
  90 or assist in its implementation may be prepared, copied, published
  91 and distributed, in whole or in part, without restriction of any
  92 kind, provided that the above copyright notice and this paragraph are
  93 included on all such copies and derivative works.  However, this
  94 document itself may not be modified in any way, such as by removing
  95 the copyright notice or references to the Internet Society or other
  96 Internet organizations, except as needed for the purpose of
  97 developing Internet standards in which case the procedures for
  98 copyrights defined in the Internet Standards process must be
  99 followed, or as required to translate it into languages other than
 100 English.
 101 .Pp
 102 The limited permissions granted above are perpetual and will not be
 103 revoked by the Internet Society or its successors or assigns.
 104 .Pp
 105 This document and the information contained herein is provided on an
 106 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
 107 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 108 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
 109 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
 110 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.