Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_x509_crq_set_subject_alt_name.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_x509_crq_set_subject_alt_name" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_x509_crq_set_subject_alt_name \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/x509.h>
7 .sp
8 .BI "int gnutls_x509_crq_set_subject_alt_name(gnutls_x509_crq_t " crq ", gnutls_x509_subject_alt_name_t " nt ", const void * " data ", unsigned int " data_size ", unsigned int " flags ");"
9 .SH ARGUMENTS
10 .IP "gnutls_x509_crq_t crq" 12
11 a certificate request of type \fBgnutls_x509_crq_t\fP
12 .IP "gnutls_x509_subject_alt_name_t nt" 12
13 is one of the \fBgnutls_x509_subject_alt_name_t\fP enumerations
14 .IP "const void * data" 12
15 The data to be set
16 .IP "unsigned int data_size" 12
17 The size of data to be set
18 .IP "unsigned int flags" 12
19 \fBGNUTLS_FSAN_SET\fP to clear previous data or
20 \fBGNUTLS_FSAN_APPEND\fP to append.
21 .SH "DESCRIPTION"
22 This function will set the subject alternative name certificate
23 extension.  It can set the following types:
24
25 &GNUTLS_SAN_DNSNAME: as a text string
26
27 &GNUTLS_SAN_RFC822NAME: as a text string
28
29 &GNUTLS_SAN_URI: as a text string
30
31 &GNUTLS_SAN_IPADDRESS: as a binary IP address (4 or 16 bytes)
32
33 Other values can be set as binary values with the proper DER encoding.
34 .SH "RETURNS"
35 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
36 negative error value.
37 .SH "SINCE"
38 2.8.0
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.