Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_x509_crt_get_ca_status.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_x509_crt_get_ca_status" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_x509_crt_get_ca_status \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/x509.h>
7 .sp
8 .BI "int gnutls_x509_crt_get_ca_status(gnutls_x509_crt_t " cert ", unsigned int * " critical ");"
9 .SH ARGUMENTS
10 .IP "gnutls_x509_crt_t cert" 12
11 should contain a \fBgnutls_x509_crt_t\fP structure
12 .IP "unsigned int * critical" 12
13 will be non zero if the extension is marked as critical
14 .SH "DESCRIPTION"
15 This function will return certificates CA status, by reading the
16 basicConstraints X.509 extension (2.5.29.19). If the certificate is
17 a CA a positive value will be returned, or zero if the certificate
18 does not have CA flag set.
19
20 Use \fBgnutls_x509_crt_get_basic_constraints()\fP if you want to read the
21 pathLenConstraint field too.
22 .SH "RETURNS"
23 A negative value may be returned in case of parsing error.
24 If the certificate does not contain the basicConstraints extension
25 \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned.
26 .SH "REPORTING BUGS"
27 Report bugs to <bug-gnutls@gnu.org>.
28 GnuTLS home page: http://www.gnu.org/software/gnutls/
29 General help using GNU software: http://www.gnu.org/gethelp/
30 .SH COPYRIGHT
31 Copyright \(co 2008 Free Software Foundation.
32 .br
33 Copying and distribution of this file, with or without modification,
34 are permitted in any medium without royalty provided the copyright
35 notice and this notice are preserved.
36 .SH "SEE ALSO"
37 The full documentation for
38 .B gnutls
39 is maintained as a Texinfo manual.  If the
40 .B info
41 and
42 .B gnutls
43 programs are properly installed at your site, the command
44 .IP
45 .B info gnutls
46 .PP
47 should give you access to the complete manual.