lib/libgssapi/gss_release_oid_set.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 .\" The following commands are required for all man pages.
  28 .Dd January 26, 2010
  29 .Dt GSS_RELEASE_OID_SET 3 PRM
  30 .Os
  31 .Sh NAME
  32 .Nm gss_release_oid_set
  33 .Nd Discard a set of object identifiers
  34 .\" This next command is for sections 2 and 3 only.
  35 .\" .Sh LIBRARY
  36 .Sh SYNOPSIS
  37 .In "gssapi/gssapi.h"
  38 .Ft OM_uint32
  39 .Fo gss_release_oid_set
  40 .Fa "OM_uint32 *minor_status"
  41 .Fa "gss_OID_set *set"
  42 .Fc
  43 .Sh DESCRIPTION
  44 Free storage associated with a GSS-API generated gss_OID_set object.
  45 The set parameter must refer to an OID-set that was returned from a
  46 GSS-API routine.
  47 .Fn gss_release_oid_set
  48 will free the storage associated with each individual member OID,
  49 the OID set's elements array,
  50 and the gss_OID_set_desc itself.
  51 .Pp
  52 Implementations are encouraged to set the gss_OID_set parameter to
  53 .Dv GSS_C_NO_OID_SET
  54 on successful completion of this routine.
  55 .Sh PARAMETERS
  56 .Bl -tag -width ".It minor_status"
  57 .It minor_status
  58 Mechanism specific status code.
  59 .It set
  60 The storage associated with the gss_OID_set will be deleted.
  61 .El
  62 .Sh RETURN VALUES
  63 .Bl -tag -width ".It GSS_S_COMPLETE"
  64 .It GSS_S_COMPLETE
  65 Successful completion
  66 .El
  67 .Sh STANDARDS
  68 .Bl -tag -width ".It RFC 2743"
  69 .It RFC 2743
  70 Generic Security Service Application Program Interface Version 2, Update 1
  71 .It RFC 2744
  72 Generic Security Service API Version 2 : C-bindings
  73 .El
  74 .Sh HISTORY
  75 The
  76 .Nm
  77 function first appeared in
  78 .Fx 7.0 .
  79 .Sh AUTHORS
  80 John Wray, Iris Associates
  81 .Sh COPYRIGHT
  82 Copyright (C) The Internet Society (2000).  All Rights Reserved.
  83 .Pp
  84 This document and translations of it may be copied and furnished to
  85 others, and derivative works that comment on or otherwise explain it
  86 or assist in its implementation may be prepared, copied, published
  87 and distributed, in whole or in part, without restriction of any
  88 kind, provided that the above copyright notice and this paragraph are
  89 included on all such copies and derivative works.  However, this
  90 document itself may not be modified in any way, such as by removing
  91 the copyright notice or references to the Internet Society or other
  92 Internet organizations, except as needed for the purpose of
  93 developing Internet standards in which case the procedures for
  94 copyrights defined in the Internet Standards process must be
  95 followed, or as required to translate it into languages other than
  96 English.
  97 .Pp
  98 The limited permissions granted above are perpetual and will not be
  99 revoked by the Internet Society or its successors or assigns.
 100 .Pp
 101 This document and the information contained herein is provided on an
 102 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
 103 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 104 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
 105 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
 106 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.