Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_x509_crt_get_crl_dist_points.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_x509_crt_get_crl_dist_points" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_x509_crt_get_crl_dist_points \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/x509.h>
7 .sp
8 .BI "int gnutls_x509_crt_get_crl_dist_points(gnutls_x509_crt_t " cert ", unsigned int " seq ", void * " ret ", size_t * " ret_size ", unsigned int * " reason_flags ", 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 seq" 12
13 specifies the sequence number of the distribution point (0 for the first one, 1 for the second etc.)
14 .IP "void * ret" 12
15 is the place where the distribution point will be copied to
16 .IP "size_t * ret_size" 12
17 holds the size of ret.
18 .IP "unsigned int * reason_flags" 12
19 Revocation reasons flags.
20 .IP "unsigned int * critical" 12
21 will be non zero if the extension is marked as critical (may be null)
22 .SH "DESCRIPTION"
23 This function retrieves the CRL distribution points (2.5.29.31),
24 contained in the given certificate in the X509v3 Certificate
25 Extensions.
26
27 \fIreason_flags\fP should be an ORed sequence of
28 \fBGNUTLS_CRL_REASON_UNUSED\fP, \fBGNUTLS_CRL_REASON_KEY_COMPROMISE\fP,
29 \fBGNUTLS_CRL_REASON_CA_COMPROMISE\fP,
30 \fBGNUTLS_CRL_REASON_AFFILIATION_CHANGED\fP,
31 \fBGNUTLS_CRL_REASON_SUPERSEEDED\fP,
32 \fBGNUTLS_CRL_REASON_CESSATION_OF_OPERATION\fP,
33 \fBGNUTLS_CRL_REASON_CERTIFICATE_HOLD\fP,
34 \fBGNUTLS_CRL_REASON_PRIVILEGE_WITHDRAWN\fP,
35 \fBGNUTLS_CRL_REASON_AA_COMPROMISE\fP, or zero for all possible reasons.
36 .SH "RETURNS"
37 \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP and updates &\fIret_size\fP if
38 &\fIret_size\fP is not enough to hold the distribution point, or the
39 type of the distribution point if everything was ok. The type is
40 one of the enumerated \fBgnutls_x509_subject_alt_name_t\fP.  If the
41 certificate does not have an Alternative name with the specified
42 sequence number then \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is
43 returned.
44 .SH "REPORTING BUGS"
45 Report bugs to <bug-gnutls@gnu.org>.
46 GnuTLS home page: http://www.gnu.org/software/gnutls/
47 General help using GNU software: http://www.gnu.org/gethelp/
48 .SH COPYRIGHT
49 Copyright \(co 2008 Free Software Foundation.
50 .br
51 Copying and distribution of this file, with or without modification,
52 are permitted in any medium without royalty provided the copyright
53 notice and this notice are preserved.
54 .SH "SEE ALSO"
55 The full documentation for
56 .B gnutls
57 is maintained as a Texinfo manual.  If the
58 .B info
59 and
60 .B gnutls
61 programs are properly installed at your site, the command
62 .IP
63 .B info gnutls
64 .PP
65 should give you access to the complete manual.