Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_x509_crq_get_dn_oid.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_x509_crq_get_dn_oid" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_x509_crq_get_dn_oid \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/x509.h>
7 .sp
8 .BI "int gnutls_x509_crq_get_dn_oid(gnutls_x509_crq_t " crq ", int " indx ", void * " oid ", size_t * " sizeof_oid ");"
9 .SH ARGUMENTS
10 .IP "gnutls_x509_crq_t crq" 12
11 should contain a gnutls_x509_crq_t structure
12 .IP "int indx" 12
13 Specifies which DN OID to send. Use zero to get the first one.
14 .IP "void * oid" 12
15 a pointer to a structure to hold the name (may be \fBNULL\fP)
16 .IP "size_t * sizeof_oid" 12
17 initially holds the size of \fIoid\fP
18 .SH "DESCRIPTION"
19 This function will extract the requested OID of the name of the
20 certificate request subject, specified by the given index.
21 .SH "RETURNS"
22 \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is
23 not long enough, and in that case the *\fIsizeof_oid\fP will be
24 updated with the required size.  On success 0 is returned.
25 .SH "REPORTING BUGS"
26 Report bugs to <bug-gnutls@gnu.org>.
27 GnuTLS home page: http://www.gnu.org/software/gnutls/
28 General help using GNU software: http://www.gnu.org/gethelp/
29 .SH COPYRIGHT
30 Copyright \(co 2008 Free Software Foundation.
31 .br
32 Copying and distribution of this file, with or without modification,
33 are permitted in any medium without royalty provided the copyright
34 notice and this notice are preserved.
35 .SH "SEE ALSO"
36 The full documentation for
37 .B gnutls
38 is maintained as a Texinfo manual.  If the
39 .B info
40 and
41 .B gnutls
42 programs are properly installed at your site, the command
43 .IP
44 .B info gnutls
45 .PP
46 should give you access to the complete manual.