Add getters for X509_STORE and X509_OBJECT members
[openssl.git] / doc / crypto / X509_STORE_get0_param.pod
1 =pod
2
3 =head1 NAME
4
5 X509_STORE_get0_param, X509_STORE_set1_param,
6 X509_STORE_get0_objects - X509_STORE setter and getter functions
7
8 =head1 SYNOPSIS
9
10  #include <openssl/x509_vfy.h>
11
12  X509_VERIFY_PARAM *X509_STORE_get0_param(X509_STORE *ctx);
13  int X509_STORE_set1_param(X509_STORE *ctx, X509_VERIFY_PARAM *pm);
14  STACK_OF(X509_OBJECT) *X509_STORE_get0_objects(X509_STORE *ctx);
15
16 =head1 DESCRIPTION
17
18 X509_STORE_set1_param() sets the verification parameters
19 to B<pm> for B<ctx>.
20
21 X509_STORE_get0_param() retrieves an internal pointer to the verification
22 parameters for B<ctx>. The returned pointer must not be freed by the
23 calling application
24
25 X509_STORE_get0_objects() retrieve an internal pointer to the store's
26 X509 object cache. The cache contains B<X509> and B<X509_CRL> objects. The
27 returned pointer must not be freed by the calling application.
28
29
30 =head1 RETURN VALUES
31
32 X509_STORE_get0_param() returns a pointer to an
33 B<X509_VERIFY_PARAM> structure.
34
35 X509_STORE_set1_param() returns 1 for success and 0 for failure.
36
37 X509_STORE_get0_objects() returns a pointer to a stack of B<X509_OBJECT>.
38
39 =head1 SEE ALSO
40
41 L<X509_STORE_new(3)>
42
43 =head1 HISTORY
44
45 B<X509_STORE_get0_param> and B<X509_STORE_get0_objects> were added in
46 OpenSSL version 1.1.0.
47
48 =cut