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