Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_x509_rdn_get.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_x509_rdn_get" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_x509_rdn_get \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/x509.h>
7 .sp
8 .BI "int gnutls_x509_rdn_get(const gnutls_datum_t * " idn ", char * " 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 "char * buf" 12
13 a pointer to a structure to hold the peer's name
14 .IP "size_t * sizeof_buf" 12
15 holds the size of \fIbuf\fP
16 .SH "DESCRIPTION"
17 This function will return the name of the given RDN sequence.  The
18 name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in
19 RFC2253.
20 .SH "RETURNS"
21 On success, \fBGNUTLS_E_SUCCESS\fP is returned, or
22 \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP is returned and *\fIsizeof_buf\fP is
23 updated if the provided buffer is not long enough, otherwise a
24 negative error value.
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.