Blame doc/functions/gnutls_x509_crq_get_subject_alt_name

Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
@deftypefun {int} {gnutls_x509_crq_get_subject_alt_name} (gnutls_x509_crq_t @var{crq}, unsigned int @var{seq}, void * @var{ret}, size_t * @var{ret_size}, unsigned int * @var{ret_type}, unsigned int * @var{critical})
Packit Service 4684c1
@var{crq}: should contain a @code{gnutls_x509_crq_t}  type
Packit Service 4684c1
Packit Service 4684c1
@var{seq}: specifies the sequence number of the alt name, 0 for the
Packit Service 4684c1
first one, 1 for the second etc.
Packit Service 4684c1
Packit Service 4684c1
@var{ret}: is the place where the alternative name will be copied to
Packit Service 4684c1
Packit Service 4684c1
@var{ret_size}: holds the size of ret.
Packit Service 4684c1
Packit Service 4684c1
@var{ret_type}: holds the @code{gnutls_x509_subject_alt_name_t}  name type
Packit Service 4684c1
Packit Service 4684c1
@var{critical}: will be non-zero if the extension is marked as critical
Packit Service 4684c1
(may be null)
Packit Service 4684c1
Packit Service 4684c1
This function will return the alternative names, contained in the
Packit Service 4684c1
given certificate.  It is the same as
Packit Service 4684c1
@code{gnutls_x509_crq_get_subject_alt_name()}  except for the fact that it
Packit Service 4684c1
will return the type of the alternative name in  @code{ret_type} even if
Packit Service 4684c1
the function fails for some reason (i.e.  the buffer provided is
Packit Service 4684c1
not enough).
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} the alternative subject name type on success, one of the
Packit Service 4684c1
enumerated @code{gnutls_x509_subject_alt_name_t} .  It will return
Packit Service 4684c1
@code{GNUTLS_E_SHORT_MEMORY_BUFFER}  if  @code{ret_size} is not large enough to
Packit Service 4684c1
hold the value.  In that case  @code{ret_size} will be updated with the
Packit Service 4684c1
required size.  If the certificate request does not have an
Packit Service 4684c1
Alternative name with the specified sequence number then
Packit Service 4684c1
@code{GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE}  is returned.
Packit Service 4684c1
Packit Service 4684c1
@strong{Since:} 2.8.0
Packit Service 4684c1
@end deftypefun