Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_session_get_data2.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_session_get_data2" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_session_get_data2 \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "int gnutls_session_get_data2(gnutls_session_t " session ", gnutls_datum_t * " data ");"
9 .SH ARGUMENTS
10 .IP "gnutls_session_t session" 12
11 is a \fBgnutls_session_t\fP structure.
12 .IP "gnutls_datum_t * data" 12
13 is a pointer to a datum that will hold the session.
14 .SH "DESCRIPTION"
15 Returns all session parameters, in order to support resuming.  The
16 client should call this, and keep the returned session, if he wants
17 to resume that current version later by calling
18 \fBgnutls_session_set_data()\fP.  This function must be called after a
19 successful handshake.  The returned datum must be freed with
20 \fBgnutls_free()\fP.
21
22 Resuming sessions is really useful and speedups connections after
23 a successful one.
24 .SH "RETURNS"
25 On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise
26 an error code is returned.
27 .SH "REPORTING BUGS"
28 Report bugs to <bug-gnutls@gnu.org>.
29 GnuTLS home page: http://www.gnu.org/software/gnutls/
30 General help using GNU software: http://www.gnu.org/gethelp/
31 .SH COPYRIGHT
32 Copyright \(co 2008 Free Software Foundation.
33 .br
34 Copying and distribution of this file, with or without modification,
35 are permitted in any medium without royalty provided the copyright
36 notice and this notice are preserved.
37 .SH "SEE ALSO"
38 The full documentation for
39 .B gnutls
40 is maintained as a Texinfo manual.  If the
41 .B info
42 and
43 .B gnutls
44 programs are properly installed at your site, the command
45 .IP
46 .B info gnutls
47 .PP
48 should give you access to the complete manual.