Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_x509_crt_get_issuer_alt_name2.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_x509_crt_get_issuer_alt_name2" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_x509_crt_get_issuer_alt_name2 \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/x509.h>
7 .sp
8 .BI "int gnutls_x509_crt_get_issuer_alt_name2(gnutls_x509_crt_t " cert ", unsigned int " seq ", void * " ret ", size_t * " ret_size ", unsigned int * " ret_type ", unsigned int * " critical ");"
9 .SH ARGUMENTS
10 .IP "gnutls_x509_crt_t cert" 12
11 should contain a \fBgnutls_x509_crt_t\fP structure
12 .IP "unsigned int seq" 12
13 specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.)
14 .IP "void * ret" 12
15 is the place where the alternative name will be copied to
16 .IP "size_t * ret_size" 12
17 holds the size of ret.
18 .IP "unsigned int * ret_type" 12
19 holds the type of the alternative name (one of gnutls_x509_subject_alt_name_t).
20 .IP "unsigned int * critical" 12
21 will be non zero if the extension is marked as critical (may be null)
22 .SH "DESCRIPTION"
23 This function will return the alternative names, contained in the
24 given certificate. It is the same as
25 \fBgnutls_x509_crt_get_issuer_alt_name()\fP except for the fact that it
26 will return the type of the alternative name in \fIret_type\fP even if
27 the function fails for some reason (i.e.  the buffer provided is
28 not enough).
29 .SH "RETURNS"
30 the alternative issuer name type on success, one of the
31 enumerated \fBgnutls_x509_subject_alt_name_t\fP.  It will return
32 \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if \fIret_size\fP is not large enough
33 to hold the value.  In that case \fIret_size\fP will be updated with
34 the required size.  If the certificate does not have an
35 Alternative name with the specified sequence number then
36 \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned.
37 .SH "SINCE"
38 2.10.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.