doc/manpages/gnutls_x509_crq_get_attribute_info.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_x509_crq_get_attribute_info" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_x509_crq_get_attribute_info \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/x509.h>
   7 .sp
   8 .BI "int gnutls_x509_crq_get_attribute_info(gnutls_x509_crq_t " crq ", int " indx ", void * " oid ", size_t * " sizeof_oid ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_x509_crq_t crq" 12
  11 should contain a \fBgnutls_x509_crq_t\fP structure
  12 .IP "int indx" 12
  13 Specifies which attribute 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 .SH "DESCRIPTION"
  20 This function will return the requested attribute OID in the
  21 certificate, and the critical flag for it.  The attribute OID will
  22 be stored as a string in the provided buffer.  Use
  23 \fBgnutls_x509_crq_get_attribute_data()\fP to extract the data.
  24
  25 If the buffer provided is not long enough to hold the output, then
  26 *\fIsizeof_oid\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will be
  27 returned.
  28 .SH "RETURNS"
  29 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
  30 negative value in case of an error.  If your have reached the
  31 last extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP
  32 will be returned.
  33 .SH "SINCE"
  34 2.8.0
  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.