Blame doc/manpages/gnutls_cipher_suite_info.3

Packit aea12f
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit aea12f
.TH "gnutls_cipher_suite_info" 3 "3.6.8" "gnutls" "gnutls"
Packit aea12f
.SH NAME
Packit aea12f
gnutls_cipher_suite_info \- API function
Packit aea12f
.SH SYNOPSIS
Packit aea12f
.B #include <gnutls/gnutls.h>
Packit aea12f
.sp
Packit aea12f
.BI "const char * gnutls_cipher_suite_info(size_t " idx ", unsigned char * " cs_id ", gnutls_kx_algorithm_t * " kx ", gnutls_cipher_algorithm_t * " cipher ", gnutls_mac_algorithm_t * " mac ", gnutls_protocol_t * " min_version ");"
Packit aea12f
.SH ARGUMENTS
Packit aea12f
.IP "size_t idx" 12
Packit aea12f
index of cipher suite to get information about, starts on 0.
Packit aea12f
.IP "unsigned char * cs_id" 12
Packit aea12f
output buffer with room for 2 bytes, indicating cipher suite value
Packit aea12f
.IP "gnutls_kx_algorithm_t * kx" 12
Packit aea12f
output variable indicating key exchange algorithm, or \fBNULL\fP.
Packit aea12f
.IP "gnutls_cipher_algorithm_t * cipher" 12
Packit aea12f
output variable indicating cipher, or \fBNULL\fP.
Packit aea12f
.IP "gnutls_mac_algorithm_t * mac" 12
Packit aea12f
output variable indicating MAC algorithm, or \fBNULL\fP.
Packit aea12f
.IP "gnutls_protocol_t * min_version" 12
Packit aea12f
output variable indicating TLS protocol version, or \fBNULL\fP.
Packit aea12f
.SH "DESCRIPTION"
Packit aea12f
Get information about supported cipher suites.  Use the function
Packit aea12f
iteratively to get information about all supported cipher suites.
Packit aea12f
Call with idx=0 to get information about first cipher suite, then
Packit aea12f
idx=1 and so on until the function returns NULL.
Packit aea12f
.SH "RETURNS"
Packit aea12f
the name of  \fIidx\fP cipher suite, and set the information
Packit aea12f
about the cipher suite in the output variables.  If  \fIidx\fP is out of
Packit aea12f
bounds, \fBNULL\fP is returned.
Packit aea12f
.SH "REPORTING BUGS"
Packit aea12f
Report bugs to <bugs@gnutls.org>.
Packit aea12f
.br
Packit aea12f
Home page: https://www.gnutls.org
Packit aea12f
Packit aea12f
.SH COPYRIGHT
Packit aea12f
Copyright \(co 2001-2019 Free Software Foundation, Inc., and others.
Packit aea12f
.br
Packit aea12f
Copying and distribution of this file, with or without modification,
Packit aea12f
are permitted in any medium without royalty provided the copyright
Packit aea12f
notice and this notice are preserved.
Packit aea12f
.SH "SEE ALSO"
Packit aea12f
The full documentation for
Packit aea12f
.B gnutls
Packit aea12f
is maintained as a Texinfo manual.
Packit aea12f
If the /usr/share/doc/gnutls/
Packit aea12f
directory does not contain the HTML form visit
Packit aea12f
.B
Packit aea12f
.IP https://www.gnutls.org/manual/
Packit aea12f
.PP