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