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