doc/manpages/gnutls_sign_algorithm_get_requested.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_sign_algorithm_get_requested" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_sign_algorithm_get_requested \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_sign_algorithm_get_requested(gnutls_session_t " session ", size_t " indx ", gnutls_sign_algorithm_t * " algo ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_session_t session" 12
  11 is a \fBgnutls_session_t\fP structure.
  12 .IP "size_t indx" 12
  13 is an index of the signature algorithm to return
  14 .IP "gnutls_sign_algorithm_t * algo" 12
  15 the returned certificate type will be stored there
  16 .SH "DESCRIPTION"
  17 Returns the signature algorithm specified by index that was
  18 requested by the peer. If the specified index has no data available
  19 this function returns \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP.  If
  20 the negotiated TLS version does not support signature algorithms
  21 then \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned even
  22 for the first index.  The first index is 0.
  23
  24 This function is useful in the certificate callback functions
  25 to assist in selecting the correct certificate.
  26 .SH "RETURNS"
  27 On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise
  28 an error code is returned.
  29 .SH "SINCE"
  30 2.10.0
  31 .SH "REPORTING BUGS"
  32 Report bugs to <bug-gnutls@gnu.org>.
  33 GnuTLS home page: http://www.gnu.org/software/gnutls/
  34 General help using GNU software: http://www.gnu.org/gethelp/
  35 .SH COPYRIGHT
  36 Copyright \(co 2008 Free Software Foundation.
  37 .br
  38 Copying and distribution of this file, with or without modification,
  39 are permitted in any medium without royalty provided the copyright
  40 notice and this notice are preserved.
  41 .SH "SEE ALSO"
  42 The full documentation for
  43 .B gnutls
  44 is maintained as a Texinfo manual.  If the
  45 .B info
  46 and
  47 .B gnutls
  48 programs are properly installed at your site, the command
  49 .IP
  50 .B info gnutls
  51 .PP
  52 should give you access to the complete manual.