Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_x509_crq_get_pk_algorithm.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_x509_crq_get_pk_algorithm" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_x509_crq_get_pk_algorithm \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/x509.h>
7 .sp
8 .BI "int gnutls_x509_crq_get_pk_algorithm(gnutls_x509_crq_t " crq ", unsigned int * " bits ");"
9 .SH ARGUMENTS
10 .IP "gnutls_x509_crq_t crq" 12
11 should contain a \fBgnutls_x509_crq_t\fP structure
12 .IP "unsigned int * bits" 12
13 if bits is non\-\fBNULL\fP it will hold the size of the parameters' in bits
14 .SH "DESCRIPTION"
15 This function will return the public key algorithm of a PKCS\fB10\fP
16 certificate request.
17
18 If bits is non\-\fBNULL\fP, it should have enough size to hold the
19 parameters size in bits.  For RSA the bits returned is the modulus.
20 For DSA the bits returned are of the public exponent.
21 .SH "RETURNS"
22 a member of the \fBgnutls_pk_algorithm_t\fP enumeration on
23 success, or a negative value on error.
24 .SH "REPORTING BUGS"
25 Report bugs to <bug-gnutls@gnu.org>.
26 GnuTLS home page: http://www.gnu.org/software/gnutls/
27 General help using GNU software: http://www.gnu.org/gethelp/
28 .SH COPYRIGHT
29 Copyright \(co 2008 Free Software Foundation.
30 .br
31 Copying and distribution of this file, with or without modification,
32 are permitted in any medium without royalty provided the copyright
33 notice and this notice are preserved.
34 .SH "SEE ALSO"
35 The full documentation for
36 .B gnutls
37 is maintained as a Texinfo manual.  If the
38 .B info
39 and
40 .B gnutls
41 programs are properly installed at your site, the command
42 .IP
43 .B info gnutls
44 .PP
45 should give you access to the complete manual.