Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_dh_get_group.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_dh_get_group" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_dh_get_group \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "int gnutls_dh_get_group(gnutls_session_t " session ", gnutls_datum_t * " raw_gen ", gnutls_datum_t * " raw_prime ");"
9 .SH ARGUMENTS
10 .IP "gnutls_session_t session" 12
11 is a gnutls session
12 .IP "gnutls_datum_t * raw_gen" 12
13 will hold the generator.
14 .IP "gnutls_datum_t * raw_prime" 12
15 will hold the prime.
16 .SH "DESCRIPTION"
17 This function will return the group parameters used in the last
18 Diffie\-Hellman key exchange with the peer.  These are the prime and
19 the generator used.  This function should be used for both
20 anonymous and ephemeral Diffie\-Hellman.  The output parameters must
21 be freed with \fBgnutls_free()\fP.
22 .SH "RETURNS"
23 On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise
24 an error code is returned.
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.