Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_x509_crt_get_extension_data.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_x509_crt_get_extension_data" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_x509_crt_get_extension_data \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/x509.h>
7 .sp
8 .BI "int gnutls_x509_crt_get_extension_data(gnutls_x509_crt_t " cert ", int " indx ", void * " data ", size_t * " sizeof_data ");"
9 .SH ARGUMENTS
10 .IP "gnutls_x509_crt_t cert" 12
11 should contain a \fBgnutls_x509_crt_t\fP structure
12 .IP "int indx" 12
13 Specifies which extension OID to send. Use zero to get the first one.
14 .IP "void * data" 12
15 a pointer to a structure to hold the data (may be null)
16 .IP "size_t * sizeof_data" 12
17 initially holds the size of \fIoid\fP
18 .SH "DESCRIPTION"
19 This function will return the requested extension data in the
20 certificate.  The extension data will be stored as a string in the
21 provided buffer.
22
23 Use \fBgnutls_x509_crt_get_extension_info()\fP to extract the OID and
24 critical flag.  Use \fBgnutls_x509_crt_get_extension_by_oid()\fP instead,
25 if you want to get data indexed by the extension OID rather than
26 sequence.
27 .SH "RETURNS"
28 On success, \fBGNUTLS_E_SUCCESS\fP (zero) is returned,
29 otherwise an error code is returned.  If you have reached the
30 last extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP
31 will be returned.
32 .SH "REPORTING BUGS"
33 Report bugs to <bug-gnutls@gnu.org>.
34 GnuTLS home page: http://www.gnu.org/software/gnutls/
35 General help using GNU software: http://www.gnu.org/gethelp/
36 .SH COPYRIGHT
37 Copyright \(co 2008 Free Software Foundation.
38 .br
39 Copying and distribution of this file, with or without modification,
40 are permitted in any medium without royalty provided the copyright
41 notice and this notice are preserved.
42 .SH "SEE ALSO"
43 The full documentation for
44 .B gnutls
45 is maintained as a Texinfo manual.  If the
46 .B info
47 and
48 .B gnutls
49 programs are properly installed at your site, the command
50 .IP
51 .B info gnutls
52 .PP
53 should give you access to the complete manual.