doc/manpages/gnutls_x509_crt_get_subject_alt_othername_oid.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_x509_crt_get_subject_alt_othername_oid" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_x509_crt_get_subject_alt_othername_oid \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/x509.h>
   7 .sp
   8 .BI "int gnutls_x509_crt_get_subject_alt_othername_oid(gnutls_x509_crt_t " cert ", unsigned int " seq ", void * " ret ", size_t * " ret_size ");"
   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 otherName OID will be copied to
  16 .IP "size_t * ret_size" 12
  17 holds the size of ret.
  18 .SH "DESCRIPTION"
  19 This function will extract the type OID of an otherName Subject
  20 Alternative Name, contained in the given certificate, and return
  21 the type as an enumerated element.
  22
  23 This function is only useful if
  24 \fBgnutls_x509_crt_get_subject_alt_name()\fP returned
  25 \fBGNUTLS_SAN_OTHERNAME\fP.
  26 .SH "RETURNS"
  27 the alternative subject name type on success, one of the
  28 enumerated gnutls_x509_subject_alt_name_t.  For supported OIDs, it
  29 will return one of the virtual (GNUTLS_SAN_OTHERNAME_*) types,
  30 e.g. \fBGNUTLS_SAN_OTHERNAME_XMPP\fP, and \fBGNUTLS_SAN_OTHERNAME\fP for
  31 unknown OIDs.  It will return \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if
  32 \fIret_size\fP is not large enough to hold the value.  In that case
  33 \fIret_size\fP will be updated with the required size.  If the
  34 certificate does not have an Alternative name with the specified
  35 sequence number and with the otherName type then
  36 \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned.
  37 .SH "REPORTING BUGS"
  38 Report bugs to <bug-gnutls@gnu.org>.
  39 GnuTLS home page: http://www.gnu.org/software/gnutls/
  40 General help using GNU software: http://www.gnu.org/gethelp/
  41 .SH COPYRIGHT
  42 Copyright \(co 2008 Free Software Foundation.
  43 .br
  44 Copying and distribution of this file, with or without modification,
  45 are permitted in any medium without royalty provided the copyright
  46 notice and this notice are preserved.
  47 .SH "SEE ALSO"
  48 The full documentation for
  49 .B gnutls
  50 is maintained as a Texinfo manual.  If the
  51 .B info
  52 and
  53 .B gnutls
  54 programs are properly installed at your site, the command
  55 .IP
  56 .B info gnutls
  57 .PP
  58 should give you access to the complete manual.