Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_x509_crq_set_dn_by_oid.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_x509_crq_set_dn_by_oid" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_x509_crq_set_dn_by_oid \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/x509.h>
7 .sp
8 .BI "int gnutls_x509_crq_set_dn_by_oid(gnutls_x509_crq_t " crq ", const char * " oid ", unsigned int " raw_flag ", const void * " data ", unsigned int " sizeof_data ");"
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 Identifier in a zero\-terminated string
14 .IP "unsigned int raw_flag" 12
15 must be 0, or 1 if the data are DER encoded
16 .IP "const void * data" 12
17 a pointer to the input data
18 .IP "unsigned int sizeof_data" 12
19 holds the size of \fIdata\fP
20 .SH "DESCRIPTION"
21 This function will set the part of the name of the Certificate
22 request subject, specified by the given OID.  The input string
23 should be ASCII or UTF\-8 encoded.
24
25 Some helper macros with popular OIDs can be found in gnutls/x509.h
26 With this function you can only set the known OIDs.  You can test
27 for known OIDs using \fBgnutls_x509_dn_oid_known()\fP.  For OIDs that are
28 not known (by gnutls) you should properly DER encode your data, and
29 call this function with raw_flag set.
30 .SH "RETURNS"
31 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
32 negative error value.
33 .SH "REPORTING BUGS"
34 Report bugs to <bug-gnutls@gnu.org>.
35 GnuTLS home page: http://www.gnu.org/software/gnutls/
36 General help using GNU software: http://www.gnu.org/gethelp/
37 .SH COPYRIGHT
38 Copyright \(co 2008 Free Software Foundation.
39 .br
40 Copying and distribution of this file, with or without modification,
41 are permitted in any medium without royalty provided the copyright
42 notice and this notice are preserved.
43 .SH "SEE ALSO"
44 The full documentation for
45 .B gnutls
46 is maintained as a Texinfo manual.  If the
47 .B info
48 and
49 .B gnutls
50 programs are properly installed at your site, the command
51 .IP
52 .B info gnutls
53 .PP
54 should give you access to the complete manual.