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