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