Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_x509_crt_set_key_purpose_oid.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_x509_crt_set_key_purpose_oid" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_x509_crt_set_key_purpose_oid \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/x509.h>
7 .sp
8 .BI "int gnutls_x509_crt_set_key_purpose_oid(gnutls_x509_crt_t " cert ", const void * " oid ", unsigned int " critical ");"
9 .SH ARGUMENTS
10 .IP "gnutls_x509_crt_t cert" 12
11 a certificate of type \fBgnutls_x509_crt_t\fP
12 .IP "const void * oid" 12
13 a pointer to a null terminated string that holds the OID
14 .IP "unsigned int critical" 12
15 Whether this extension will be critical or not
16 .SH "DESCRIPTION"
17 This function will set the key purpose OIDs of the Certificate.
18 These are stored in the Extended Key Usage extension (2.5.29.37)
19 See the GNUTLS_KP_* definitions for human readable names.
20
21 Subsequent calls to this function will append OIDs to the OID list.
22 .SH "RETURNS"
23 On success, \fBGNUTLS_E_SUCCESS\fP (zero) is returned,
24 otherwise an error code is returned.
25 .SH "REPORTING BUGS"
26 Report bugs to <bug-gnutls@gnu.org>.
27 GnuTLS home page: http://www.gnu.org/software/gnutls/
28 General help using GNU software: http://www.gnu.org/gethelp/
29 .SH COPYRIGHT
30 Copyright \(co 2008 Free Software Foundation.
31 .br
32 Copying and distribution of this file, with or without modification,
33 are permitted in any medium without royalty provided the copyright
34 notice and this notice are preserved.
35 .SH "SEE ALSO"
36 The full documentation for
37 .B gnutls
38 is maintained as a Texinfo manual.  If the
39 .B info
40 and
41 .B gnutls
42 programs are properly installed at your site, the command
43 .IP
44 .B info gnutls
45 .PP
46 should give you access to the complete manual.