Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_pubkey_set_key_usage.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_pubkey_set_key_usage" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_pubkey_set_key_usage \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "int gnutls_pubkey_set_key_usage(gnutls_pubkey_t " key ", unsigned int " usage ");"
9 .SH ARGUMENTS
10 .IP "gnutls_pubkey_t key" 12
11 a certificate of type \fBgnutls_x509_crt_t\fP
12 .IP "unsigned int usage" 12
13 an ORed sequence of the GNUTLS_KEY_* elements.
14 .SH "DESCRIPTION"
15 This function will set the key usage flags of the public key. This
16 is only useful if the key is to be exported to a certificate or
17 certificate request.
18 .SH "RETURNS"
19 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
20 negative error value.
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.