Add support for passing the libctx to the config loader
[openssl.git] / doc / man3 / CONF_modules_free.pod
1 =pod
2
3 =head1 NAME
4
5 CONF_modules_free, CONF_modules_finish, CONF_modules_unload -
6 OpenSSL configuration cleanup functions
7
8 =head1 SYNOPSIS
9
10  #include <openssl/conf.h>
11
12  void CONF_modules_finish(void);
13  void CONF_modules_unload(int all);
14
15 Deprecated since OpenSSL 1.1.0, can be hidden entirely by defining
16 B<OPENSSL_API_COMPAT> with a suitable version value, see
17 L<openssl_user_macros(7)>:
18
19  void CONF_modules_free(void)
20
21 =head1 DESCRIPTION
22
23 CONF_modules_free() closes down and frees up all memory allocated by all
24 configuration modules.  Normally, in versions of OpenSSL prior to 1.1.0,
25 applications called
26 CONF_modules_free() at exit to tidy up any configuration performed.
27
28 CONF_modules_finish() calls each configuration modules B<finish> handler
29 to free up any configuration that module may have performed.
30
31 CONF_modules_unload() finishes and unloads configuration modules. If
32 B<all> is set to B<0> only modules loaded from DSOs will be unloads. If
33 B<all> is B<1> all modules, including built-in modules will be unloaded.
34
35 =head1 RETURN VALUES
36
37 None of the functions return a value.
38
39 =head1 SEE ALSO
40
41 L<config(5)>, L<OPENSSL_config(3)>,
42 L<CONF_modules_load_file_with_libctx(3)>
43
44 =head1 HISTORY
45
46 CONF_modules_free() was deprecated in OpenSSL 1.1.0; do not use it.
47 For more information see L<OPENSSL_init_crypto(3)>.
48
49 =head1 COPYRIGHT
50
51 Copyright 2004-2018 The OpenSSL Project Authors. All Rights Reserved.
52
53 Licensed under the Apache License 2.0 (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