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