File: gss_inquire_saslname_for_mech.3

package info (click to toggle)
gss 1.0.4-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 8,168 kB
  • sloc: ansic: 22,018; sh: 7,410; python: 2,873; perl: 861; makefile: 334; xml: 52; sed: 16
file content (59 lines) | stat: -rw-r--r-- 2,272 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gss_inquire_saslname_for_mech" 3 "1.0.4" "gss" "gss"
.SH NAME
gss_inquire_saslname_for_mech \- API function
.SH SYNOPSIS
.B #include <gss.h>
.sp
.BI "OM_uint32 gss_inquire_saslname_for_mech(OM_uint32 * " minor_status ", const gss_OID " desired_mech ", gss_buffer_t " sasl_mech_name ", gss_buffer_t " mech_name ", gss_buffer_t " mech_description ");"
.SH ARGUMENTS
.IP "OM_uint32 * minor_status" 12
(Integer, modify) Mechanism specific status code.
.IP "const gss_OID desired_mech" 12
(OID, read) Identifies the GSS\-API mechanism to query.
.IP "gss_buffer_t sasl_mech_name" 12
(buffer, character\-string, modify, optional)
  Buffer to receive SASL mechanism name.  The application must free
  storage associated with this name after use with a call to
  \fBgss_release_buffer()\fP.
.IP "gss_buffer_t mech_name" 12
(buffer, character\-string, modify, optional) Buffer to
  receive human readable mechanism name.  The application must free
  storage associated with this name after use with a call to
  \fBgss_release_buffer()\fP.
.IP "gss_buffer_t mech_description" 12
(buffer, character\-string, modify, optional)
  Buffer to receive description of mechanism.  The application must
  free storage associated with this name after use with a call to
  \fBgss_release_buffer()\fP.
.SH "DESCRIPTION"
Output the SASL mechanism name of a GSS\-API mechanism.  It also
returns a name and description of the mechanism in a user friendly
form.
.SH "RETURNS"

`GSS_S_COMPLETE`: Successful completion.

`GSS_S_BAD_MECH`: The \fIdesired_mech\fP OID is unsupported.
.SH "REPORTING BUGS"
Report bugs to <bug-gss@gnu.org>.
GNU Generic Security Service home page: http://www.gnu.org/software/gss/
General help using GNU software: http://www.gnu.org/gethelp/
.SH COPYRIGHT
Copyright \(co 2003-2022 Simon Josefsson.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
.SH "SEE ALSO"
The full documentation for
.B gss
is maintained as a Texinfo manual.  If the
.B info
and
.B gss
programs are properly installed at your site, the command
.IP
.B info gss
.PP
should give you access to the complete manual.