Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_x509_crt_get_extension_by_oid.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_x509_crt_get_extension_by_oid" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_x509_crt_get_extension_by_oid \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/x509.h>
7 .sp
8 .BI "int gnutls_x509_crt_get_extension_by_oid(gnutls_x509_crt_t " cert ", const char * " oid ", int " indx ", void * " buf ", size_t * " sizeof_buf ", 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 "const char * oid" 12
13 holds an Object Identified in null terminated string
14 .IP "int indx" 12
15 In case multiple same OIDs exist in the extensions, this specifies which to send. Use zero to get the first one.
16 .IP "void * buf" 12
17 a pointer to a structure to hold the name (may be null)
18 .IP "size_t * sizeof_buf" 12
19 initially holds the size of \fIbuf\fP
20 .IP "unsigned int * critical" 12
21 will be non zero if the extension is marked as critical
22 .SH "DESCRIPTION"
23 This function will return the extension specified by the OID in the
24 certificate.  The extensions will be returned as binary data DER
25 encoded, in the provided buffer.
26 .SH "RETURNS"
27 On success, \fBGNUTLS_E_SUCCESS\fP (zero) is returned,
28 otherwise an error code is returned. If the certificate does not
29 contain the specified extension
30 GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned.
31 .SH "REPORTING BUGS"
32 Report bugs to <bug-gnutls@gnu.org>.
33 GnuTLS home page: http://www.gnu.org/software/gnutls/
34 General help using GNU software: http://www.gnu.org/gethelp/
35 .SH COPYRIGHT
36 Copyright \(co 2008 Free Software Foundation.
37 .br
38 Copying and distribution of this file, with or without modification,
39 are permitted in any medium without royalty provided the copyright
40 notice and this notice are preserved.
41 .SH "SEE ALSO"
42 The full documentation for
43 .B gnutls
44 is maintained as a Texinfo manual.  If the
45 .B info
46 and
47 .B gnutls
48 programs are properly installed at your site, the command
49 .IP
50 .B info gnutls
51 .PP
52 should give you access to the complete manual.