Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_psk_client_get_hint.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_psk_client_get_hint" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_psk_client_get_hint \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "const char * gnutls_psk_client_get_hint(gnutls_session_t " session ");"
9 .SH ARGUMENTS
10 .IP "gnutls_session_t session" 12
11 is a gnutls session
12 .SH "DESCRIPTION"
13 The PSK identity hint may give the client help in deciding which
14 username to use.  This should only be called in case of PSK
15 authentication and in case of a client.
16 .SH "RETURNS"
17 the identity hint of the peer, or \fBNULL\fP in case of an error.
18 .SH "SINCE"
19 2.4.0
20 .SH "REPORTING BUGS"
21 Report bugs to <bug-gnutls@gnu.org>.
22 GnuTLS home page: http://www.gnu.org/software/gnutls/
23 General help using GNU software: http://www.gnu.org/gethelp/
24 .SH COPYRIGHT
25 Copyright \(co 2008 Free Software Foundation.
26 .br
27 Copying and distribution of this file, with or without modification,
28 are permitted in any medium without royalty provided the copyright
29 notice and this notice are preserved.
30 .SH "SEE ALSO"
31 The full documentation for
32 .B gnutls
33 is maintained as a Texinfo manual.  If the
34 .B info
35 and
36 .B gnutls
37 programs are properly installed at your site, the command
38 .IP
39 .B info gnutls
40 .PP
41 should give you access to the complete manual.