doc/manpages/gnutls_x509_crq_get_basic_constraints.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_x509_crq_get_basic_constraints" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_x509_crq_get_basic_constraints \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/x509.h>
   7 .sp
   8 .BI "int gnutls_x509_crq_get_basic_constraints(gnutls_x509_crq_t " crq ", unsigned int * " critical ", int * " ca ", int * " pathlen ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_x509_crq_t crq" 12
  11 should contain a \fBgnutls_x509_crq_t\fP structure
  12 .IP "unsigned int * critical" 12
  13 will be non zero if the extension is marked as critical
  14 .IP "int * ca" 12
  15 pointer to output integer indicating CA status, may be NULL,
  16 value is 1 if the certificate CA flag is set, 0 otherwise.
  17 .IP "int * pathlen" 12
  18 pointer to output integer indicating path length (may be
  19 NULL), non\-negative values indicate a present pathLenConstraint
  20 field and the actual value, \-1 indicate that the field is absent.
  21 .SH "DESCRIPTION"
  22 This function will read the certificate's basic constraints, and
  23 return the certificates CA status.  It reads the basicConstraints
  24 X.509 extension (2.5.29.19).
  25 .SH "RETURN VALUE"
  26 If the certificate is a CA a positive value will be
  27 returned, or zero if the certificate does not have CA flag set.
  28 A negative value may be returned in case of errors.  If the
  29 certificate does not contain the basicConstraints extension
  30 \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned.
  31 .SH "SINCE"
  32 2.8.0
  33 .SH "REPORTING BUGS"
  34 Report bugs to <bug-gnutls@gnu.org>.
  35 GnuTLS home page: http://www.gnu.org/software/gnutls/
  36 General help using GNU software: http://www.gnu.org/gethelp/
  37 .SH COPYRIGHT
  38 Copyright \(co 2008 Free Software Foundation.
  39 .br
  40 Copying and distribution of this file, with or without modification,
  41 are permitted in any medium without royalty provided the copyright
  42 notice and this notice are preserved.
  43 .SH "SEE ALSO"
  44 The full documentation for
  45 .B gnutls
  46 is maintained as a Texinfo manual.  If the
  47 .B info
  48 and
  49 .B gnutls
  50 programs are properly installed at your site, the command
  51 .IP
  52 .B info gnutls
  53 .PP
  54 should give you access to the complete manual.