Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_db_set_retrieve_function.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_db_set_retrieve_function" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_db_set_retrieve_function \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "void gnutls_db_set_retrieve_function(gnutls_session_t " session ", gnutls_db_retr_func " retr_func ");"
9 .SH ARGUMENTS
10 .IP "gnutls_session_t session" 12
11 is a \fBgnutls_session_t\fP structure.
12 .IP "gnutls_db_retr_func retr_func" 12
13 is the function.
14 .SH "DESCRIPTION"
15 Sets the function that will be used to retrieve data from the
16 resumed sessions database.  This function must return a
17 gnutls_datum_t containing the data on success, or a gnutls_datum_t
18 containing null and 0 on failure.
19
20 The datum's data must be allocated using the function
21 \fBgnutls_malloc()\fP.
22
23 The first argument to \fIretr_func\fP will be null unless
24 \fBgnutls_db_set_ptr()\fP has been called.
25 .SH "REPORTING BUGS"
26 Report bugs to <bug-gnutls@gnu.org>.
27 GnuTLS home page: http://www.gnu.org/software/gnutls/
28 General help using GNU software: http://www.gnu.org/gethelp/
29 .SH COPYRIGHT
30 Copyright \(co 2008 Free Software Foundation.
31 .br
32 Copying and distribution of this file, with or without modification,
33 are permitted in any medium without royalty provided the copyright
34 notice and this notice are preserved.
35 .SH "SEE ALSO"
36 The full documentation for
37 .B gnutls
38 is maintained as a Texinfo manual.  If the
39 .B info
40 and
41 .B gnutls
42 programs are properly installed at your site, the command
43 .IP
44 .B info gnutls
45 .PP
46 should give you access to the complete manual.