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