Blame doc/manpages/gnutls_x509_crq_get_subject_alt_name.3

Packit aea12f
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit aea12f
.TH "gnutls_x509_crq_get_subject_alt_name" 3 "3.6.8" "gnutls" "gnutls"
Packit aea12f
.SH NAME
Packit aea12f
gnutls_x509_crq_get_subject_alt_name \- API function
Packit aea12f
.SH SYNOPSIS
Packit aea12f
.B #include <gnutls/x509.h>
Packit aea12f
.sp
Packit aea12f
.BI "int gnutls_x509_crq_get_subject_alt_name(gnutls_x509_crq_t " crq ", unsigned int " seq ", void * " ret ", size_t * " ret_size ", unsigned int * " ret_type ", unsigned int * " critical ");"
Packit aea12f
.SH ARGUMENTS
Packit aea12f
.IP "gnutls_x509_crq_t crq" 12
Packit aea12f
should contain a \fBgnutls_x509_crq_t\fP type
Packit aea12f
.IP "unsigned int seq" 12
Packit aea12f
specifies the sequence number of the alt name, 0 for the
Packit aea12f
first one, 1 for the second etc.
Packit aea12f
.IP "void * ret" 12
Packit aea12f
is the place where the alternative name will be copied to
Packit aea12f
.IP "size_t * ret_size" 12
Packit aea12f
holds the size of ret.
Packit aea12f
.IP "unsigned int * ret_type" 12
Packit aea12f
holds the \fBgnutls_x509_subject_alt_name_t\fP name type
Packit aea12f
.IP "unsigned int * critical" 12
Packit aea12f
will be non\-zero if the extension is marked as critical
Packit aea12f
(may be null)
Packit aea12f
.SH "DESCRIPTION"
Packit aea12f
This function will return the alternative names, contained in the
Packit aea12f
given certificate.  It is the same as
Packit aea12f
\fBgnutls_x509_crq_get_subject_alt_name()\fP except for the fact that it
Packit aea12f
will return the type of the alternative name in  \fIret_type\fP even if
Packit aea12f
the function fails for some reason (i.e.  the buffer provided is
Packit aea12f
not enough).
Packit aea12f
.SH "RETURNS"
Packit aea12f
the alternative subject name type on success, one of the
Packit aea12f
enumerated \fBgnutls_x509_subject_alt_name_t\fP.  It will return
Packit aea12f
\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if  \fIret_size\fP is not large enough to
Packit aea12f
hold the value.  In that case  \fIret_size\fP will be updated with the
Packit aea12f
required size.  If the certificate request does not have an
Packit aea12f
Alternative name with the specified sequence number then
Packit aea12f
\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned.
Packit aea12f
.SH "SINCE"
Packit aea12f
2.8.0
Packit aea12f
.SH "REPORTING BUGS"
Packit aea12f
Report bugs to <bugs@gnutls.org>.
Packit aea12f
.br
Packit aea12f
Home page: https://www.gnutls.org
Packit aea12f
Packit aea12f
.SH COPYRIGHT
Packit aea12f
Copyright \(co 2001-2019 Free Software Foundation, Inc., and others.
Packit aea12f
.br
Packit aea12f
Copying and distribution of this file, with or without modification,
Packit aea12f
are permitted in any medium without royalty provided the copyright
Packit aea12f
notice and this notice are preserved.
Packit aea12f
.SH "SEE ALSO"
Packit aea12f
The full documentation for
Packit aea12f
.B gnutls
Packit aea12f
is maintained as a Texinfo manual.
Packit aea12f
If the /usr/share/doc/gnutls/
Packit aea12f
directory does not contain the HTML form visit
Packit aea12f
.B
Packit aea12f
.IP https://www.gnutls.org/manual/
Packit aea12f
.PP