Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_x509_rdn_get_by_oid.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_x509_rdn_get_by_oid" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_x509_rdn_get_by_oid \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/x509.h>
7 .sp
8 .BI "int gnutls_x509_rdn_get_by_oid(const gnutls_datum_t * " idn ", const char * " oid ", int " indx ", unsigned int " raw_flag ", void * " buf ", size_t * " sizeof_buf ");"
9 .SH ARGUMENTS
10 .IP "const gnutls_datum_t * idn" 12
11 should contain a DER encoded RDN sequence
12 .IP "const char * oid" 12
13 an Object Identifier
14 .IP "int indx" 12
15 In case multiple same OIDs exist in the RDN indicates which
16 to send. Use 0 for the first one.
17 .IP "unsigned int raw_flag" 12
18 If non zero then the raw DER data are returned.
19 .IP "void * buf" 12
20 a pointer to a structure to hold the peer's name
21 .IP "size_t * sizeof_buf" 12
22 holds the size of \fIbuf\fP
23 .SH "DESCRIPTION"
24 This function will return the name of the given Object identifier,
25 of the RDN sequence.  The name will be encoded using the rules
26 from RFC2253.
27 .SH "RETURNS"
28 On success, \fBGNUTLS_E_SUCCESS\fP is returned, or
29 \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP is returned and *\fIsizeof_buf\fP is
30 updated if the provided buffer is not long enough, otherwise a
31 negative error value.
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.