Add X509 related libctx changes.
[openssl.git] / doc / man3 / X509_STORE_new.pod
1 =pod
2
3 =head1 NAME
4
5 X509_STORE_new, X509_STORE_up_ref, X509_STORE_free,
6 X509_STORE_lock,X509_STORE_unlock
7 - X509_STORE allocation, freeing and locking functions
8
9 =head1 SYNOPSIS
10
11  #include <openssl/x509_vfy.h>
12
13  X509_STORE *X509_STORE_new(void);
14  void X509_STORE_free(X509_STORE *v);
15  int X509_STORE_lock(X509_STORE *v);
16  int X509_STORE_unlock(X509_STORE *v);
17  int X509_STORE_up_ref(X509_STORE *v);
18
19 =head1 DESCRIPTION
20
21 The X509_STORE_new() function returns a new X509_STORE.
22
23 X509_STORE_up_ref() increments the reference count associated with the
24 X509_STORE object.
25
26 X509_STORE_lock() locks the store from modification by other threads,
27 X509_STORE_unlock() unlocks it.
28
29 X509_STORE_free() frees up a single X509_STORE object.
30
31 =head1 RETURN VALUES
32
33 X509_STORE_new() returns a newly created X509_STORE or NULL if the call fails.
34
35 X509_STORE_up_ref(), X509_STORE_lock() and X509_STORE_unlock() return
36 1 for success and 0 for failure.
37
38 X509_STORE_free() does not return values.
39
40 =head1 SEE ALSO
41
42 L<X509_STORE_set_verify_cb_func(3)>
43 L<X509_STORE_get0_param(3)>
44
45 =head1 HISTORY
46
47 The X509_STORE_up_ref(), X509_STORE_lock() and X509_STORE_unlock()
48 functions were added in OpenSSL 1.1.0.
49
50 =head1 COPYRIGHT
51
52 Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
53
54 Licensed under the Apache License 2.0 (the "License").  You may not use
55 this file except in compliance with the License.  You can obtain a copy
56 in the file LICENSE in the source distribution or at
57 L<https://www.openssl.org/source/license.html>.
58
59 =cut