lib/libgssapi/gss_create_empty_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 .\" The following commands are required for all man pages.
  30 .Dd November 12, 2005
  31 .Os
  32 .Dt GSS_CREATE_EMPTY_OID_SET 3 PRM
  33 .Sh NAME
  34 .Nm gss_create_empty_oid_set
  35 .Nd Create a set containing no 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_create_empty_oid_set
  42 .Fa "OM_uint32 *minor_status"
  43 .Fa "gss_OID_set *oid_set"
  44 .Fc
  45 .Sh DESCRIPTION
  46 Create an object-identifier set containing no object identifiers,
  47 to which members may be subsequently added using the
  48 .Fn gss_add_oid_set_member
  49 routine.
  50 These routines are intended to be used to construct sets of mechanism
  51 object identifiers for input to
  52 .Fn gss_acquire_cred .
  53 .Sh PARAMETERS
  54 .Bl -tag
  55 .It minor_status
  56 Mechanism specific status code.
  57 .It oid_set
  58
  59 The empty object identifier set.
  60 The routine will allocate the gss_OID_set_desc object,
  61 which the application must free after use with a call to
  62 .Fn gss_release_oid_set .
  63 .El
  64 .Sh RETURN VALUES
  65 .Bl -tag
  66 .It GSS_S_COMPLETE
  67 Successful completion
  68 .El
  69 .Sh SEE ALSO
  70 .Xr gss_add_oid_set_member 3 ,
  71 .Xr gss_acquire_cred 3
  72 .Sh STANDARDS
  73 .Bl -tag
  74 .It RFC 2743
  75 Generic Security Service Application Program Interface Version 2, Update 1
  76 .It RFC 2744
  77 Generic Security Service API Version 2 : C-bindings
  78 .\" .Sh HISTORY
  79 .El
  80 .Sh HISTORY
  81 The
  82 .Nm
  83 manual page example first appeared in
  84 .Fx 7.0 .
  85 .Sh AUTHORS
  86 John Wray, Iris Associates
  87 .Sh COPYRIGHT
  88 Copyright (C) The Internet Society (2000).  All Rights Reserved.
  89 .Pp
  90 This document and translations of it may be copied and furnished to
  91 others, and derivative works that comment on or otherwise explain it
  92 or assist in its implementation may be prepared, copied, published
  93 and distributed, in whole or in part, without restriction of any
  94 kind, provided that the above copyright notice and this paragraph are
  95 included on all such copies and derivative works.  However, this
  96 document itself may not be modified in any way, such as by removing
  97 the copyright notice or references to the Internet Society or other
  98 Internet organizations, except as needed for the purpose of
  99 developing Internet standards in which case the procedures for
 100 copyrights defined in the Internet Standards process must be
 101 followed, or as required to translate it into languages other than
 102 English.
 103 .Pp
 104 The limited permissions granted above are perpetual and will not be
 105 revoked by the Internet Society or its successors or assigns.
 106 .Pp
 107 This document and the information contained herein is provided on an
 108 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
 109 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 110 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
 111 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
 112 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.