doc/manpages/gnutls_x509_crt_get_extension_info.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_x509_crt_get_extension_info" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_x509_crt_get_extension_info \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/x509.h>
   7 .sp
   8 .BI "int gnutls_x509_crt_get_extension_info(gnutls_x509_crt_t " cert ", int " indx ", void * " oid ", size_t * " sizeof_oid ", 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 "int indx" 12
  13 Specifies which extension OID to send. Use zero to get the first one.
  14 .IP "void * oid" 12
  15 a pointer to a structure to hold the OID
  16 .IP "size_t * sizeof_oid" 12
  17 initially holds the maximum size of \fIoid\fP, on return
  18 holds actual size of \fIoid\fP.
  19 .IP "int * critical" 12
  20 output variable with critical flag, may be NULL.
  21 .SH "DESCRIPTION"
  22 This function will return the requested extension OID in the
  23 certificate, and the critical flag for it.  The extension OID will
  24 be stored as a string in the provided buffer.  Use
  25 \fBgnutls_x509_crt_get_extension_data()\fP to extract the data.
  26
  27 If the buffer provided is not long enough to hold the output, then
  28 *\fIsizeof_oid\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will be
  29 returned.
  30 .SH "RETURNS"
  31 On success, \fBGNUTLS_E_SUCCESS\fP (zero) is returned,
  32 otherwise an error code is returned.  If you have reached the
  33 last extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP
  34 will be returned.
  35 .SH "REPORTING BUGS"
  36 Report bugs to <bug-gnutls@gnu.org>.
  37 GnuTLS home page: http://www.gnu.org/software/gnutls/
  38 General help using GNU software: http://www.gnu.org/gethelp/
  39 .SH COPYRIGHT
  40 Copyright \(co 2008 Free Software Foundation.
  41 .br
  42 Copying and distribution of this file, with or without modification,
  43 are permitted in any medium without royalty provided the copyright
  44 notice and this notice are preserved.
  45 .SH "SEE ALSO"
  46 The full documentation for
  47 .B gnutls
  48 is maintained as a Texinfo manual.  If the
  49 .B info
  50 and
  51 .B gnutls
  52 programs are properly installed at your site, the command
  53 .IP
  54 .B info gnutls
  55 .PP
  56 should give you access to the complete manual.