Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_kx_set_priority.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_kx_set_priority" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_kx_set_priority \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "int gnutls_kx_set_priority(gnutls_session_t " session ", const int * " list ");"
9 .SH ARGUMENTS
10 .IP "gnutls_session_t session" 12
11 is a \fBgnutls_session_t\fP structure.
12 .IP "const int * list" 12
13 is a 0 terminated list of gnutls_kx_algorithm_t elements.
14 .SH "DESCRIPTION"
15 Sets the priority on the key exchange algorithms supported by
16 gnutls.  Priority is higher for elements specified before others.
17 After specifying the algorithms you want, you must append a 0.
18 Note that the priority is set on the client. The server does not
19 use the algorithm's priority except for disabling algorithms that
20 were not specified.
21 .SH "RETURNS"
22 \fBGNUTLS_E_SUCCESS\fP on success, or an error code.
23 .SH "REPORTING BUGS"
24 Report bugs to <bug-gnutls@gnu.org>.
25 GnuTLS home page: http://www.gnu.org/software/gnutls/
26 General help using GNU software: http://www.gnu.org/gethelp/
27 .SH COPYRIGHT
28 Copyright \(co 2008 Free Software Foundation.
29 .br
30 Copying and distribution of this file, with or without modification,
31 are permitted in any medium without royalty provided the copyright
32 notice and this notice are preserved.
33 .SH "SEE ALSO"
34 The full documentation for
35 .B gnutls
36 is maintained as a Texinfo manual.  If the
37 .B info
38 and
39 .B gnutls
40 programs are properly installed at your site, the command
41 .IP
42 .B info gnutls
43 .PP
44 should give you access to the complete manual.