Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_dh_params_init.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_dh_params_init" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_dh_params_init \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "int gnutls_dh_params_init(gnutls_dh_params_t * " dh_params ");"
9 .SH ARGUMENTS
10 .IP "gnutls_dh_params_t * dh_params" 12
11 Is a structure that will hold the prime numbers
12 .SH "DESCRIPTION"
13 This function will initialize the DH parameters structure.
14 .SH "RETURNS"
15 On success, \fBGNUTLS_E_SUCCESS\fP (zero) is returned,
16 otherwise an error code is returned.
17 .SH "REPORTING BUGS"
18 Report bugs to <bug-gnutls@gnu.org>.
19 GnuTLS home page: http://www.gnu.org/software/gnutls/
20 General help using GNU software: http://www.gnu.org/gethelp/
21 .SH COPYRIGHT
22 Copyright \(co 2008 Free Software Foundation.
23 .br
24 Copying and distribution of this file, with or without modification,
25 are permitted in any medium without royalty provided the copyright
26 notice and this notice are preserved.
27 .SH "SEE ALSO"
28 The full documentation for
29 .B gnutls
30 is maintained as a Texinfo manual.  If the
31 .B info
32 and
33 .B gnutls
34 programs are properly installed at your site, the command
35 .IP
36 .B info gnutls
37 .PP
38 should give you access to the complete manual.