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