doc/manpages/gnutls_cipher_suite_info.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_cipher_suite_info" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_cipher_suite_info \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "const char * gnutls_cipher_suite_info(size_t " idx ", char * " cs_id ", gnutls_kx_algorithm_t * " kx ", gnutls_cipher_algorithm_t * " cipher ", gnutls_mac_algorithm_t * " mac ", gnutls_protocol_t * " min_version ");"
   9 .SH ARGUMENTS
  10 .IP "size_t idx" 12
  11 index of cipher suite to get information about, starts on 0.
  12 .IP "char * cs_id" 12
  13 output buffer with room for 2 bytes, indicating cipher suite value
  14 .IP "gnutls_kx_algorithm_t * kx" 12
  15 output variable indicating key exchange algorithm, or \fBNULL\fP.
  16 .IP "gnutls_cipher_algorithm_t * cipher" 12
  17 output variable indicating cipher, or \fBNULL\fP.
  18 .IP "gnutls_mac_algorithm_t * mac" 12
  19 output variable indicating MAC algorithm, or \fBNULL\fP.
  20 .IP "gnutls_protocol_t * min_version" 12
  21 .SH "DESCRIPTION"
  22 Get information about supported cipher suites.  Use the function
  23 iteratively to get information about all supported cipher suites.
  24 Call with idx=0 to get information about first cipher suite, then
  25 idx=1 and so on until the function returns NULL.
  26 .SH "RETURNS"
  27 the name of \fIidx\fP cipher suite, and set the information
  28 about the cipher suite in the output variables.  If \fIidx\fP is out of
  29 bounds, \fBNULL\fP is returned.
  30 .SH "REPORTING BUGS"
  31 Report bugs to <bug-gnutls@gnu.org>.
  32 GnuTLS home page: http://www.gnu.org/software/gnutls/
  33 General help using GNU software: http://www.gnu.org/gethelp/
  34 .SH COPYRIGHT
  35 Copyright \(co 2008 Free Software Foundation.
  36 .br
  37 Copying and distribution of this file, with or without modification,
  38 are permitted in any medium without royalty provided the copyright
  39 notice and this notice are preserved.
  40 .SH "SEE ALSO"
  41 The full documentation for
  42 .B gnutls
  43 is maintained as a Texinfo manual.  If the
  44 .B info
  45 and
  46 .B gnutls
  47 programs are properly installed at your site, the command
  48 .IP
  49 .B info gnutls
  50 .PP
  51 should give you access to the complete manual.