summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_psk_server_get_username.3
blob: 5cd14f57ec85bafcc03c5f96d8a6879faa74582a (plain)
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
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_psk_server_get_username" 3 "3.7.9" "gnutls" "gnutls"
.SH NAME
gnutls_psk_server_get_username \- API function
.SH SYNOPSIS
.B #include <gnutls/gnutls.h>
.sp
.BI "const char * gnutls_psk_server_get_username(gnutls_session_t " session ");"
.SH ARGUMENTS
.IP "gnutls_session_t session" 12
is a gnutls session
.SH "DESCRIPTION"
This should only be called in case of PSK authentication and in
case of a server.

The returned pointer should be considered constant (do not free) and valid 
for the lifetime of the session.

This function will return \fBNULL\fP if the username has embedded NULL bytes.
In that case, \fBgnutls_psk_server_get_username2()\fP should be used to retrieve the username.
.SH "RETURNS"
the username of the peer, or \fBNULL\fP in case of an error,
or if the username has embedded NULLs.
.SH "REPORTING BUGS"
Report bugs to <bugs@gnutls.org>.
.br
Home page: https://www.gnutls.org

.SH COPYRIGHT
Copyright \(co 2001- Free Software Foundation, Inc., and others.
.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 gnutls
is maintained as a Texinfo manual.
If the /usr/share/doc/gnutls/
directory does not contain the HTML form visit
.B
.IP https://www.gnutls.org/manual/
.PP