Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_x509_crl_get_issuer_dn_by_oid.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_x509_crl_get_issuer_dn_by_oid" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_x509_crl_get_issuer_dn_by_oid \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/x509.h>
7 .sp
8 .BI "int gnutls_x509_crl_get_issuer_dn_by_oid(gnutls_x509_crl_t " crl ", const char * " oid ", int " indx ", unsigned int " raw_flag ", void * " buf ", size_t * " sizeof_buf ");"
9 .SH ARGUMENTS
10 .IP "gnutls_x509_crl_t crl" 12
11 should contain a gnutls_x509_crl_t 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 RDN, this specifies which to send. Use zero to get the first one.
16 .IP "unsigned int raw_flag" 12
17 If non zero returns the raw DER data of the DN part.
18 .IP "void * buf" 12
19 a pointer to a structure to hold the peer's name (may be null)
20 .IP "size_t * sizeof_buf" 12
21 initially holds the size of \fIbuf\fP
22 .SH "DESCRIPTION"
23 This function will extract the part of the name of the CRL issuer
24 specified by the given OID. The output will be encoded as described
25 in RFC2253. The output string will be ASCII or UTF\-8 encoded,
26 depending on the certificate data.
27
28 Some helper macros with popular OIDs can be found in gnutls/x509.h
29 If raw flag is zero, this function will only return known OIDs as
30 text. Other OIDs will be DER encoded, as described in RFC2253 \-\- in
31 hex format with a '\#' prefix.  You can check about known OIDs
32 using \fBgnutls_x509_dn_oid_known()\fP.
33
34 If buf is null then only the size will be filled.
35 .SH "RETURNS"
36 \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is
37 not long enough, and in that case the sizeof_buf will be updated
38 with the required size, and 0 on success.
39 .SH "REPORTING BUGS"
40 Report bugs to <bug-gnutls@gnu.org>.
41 GnuTLS home page: http://www.gnu.org/software/gnutls/
42 General help using GNU software: http://www.gnu.org/gethelp/
43 .SH COPYRIGHT
44 Copyright \(co 2008 Free Software Foundation.
45 .br
46 Copying and distribution of this file, with or without modification,
47 are permitted in any medium without royalty provided the copyright
48 notice and this notice are preserved.
49 .SH "SEE ALSO"
50 The full documentation for
51 .B gnutls
52 is maintained as a Texinfo manual.  If the
53 .B info
54 and
55 .B gnutls
56 programs are properly installed at your site, the command
57 .IP
58 .B info gnutls
59 .PP
60 should give you access to the complete manual.