aboutsummaryrefslogtreecommitdiff
path: root/openssl-1.1.0h/doc/crypto/CONF_modules_free.pod
blob: ac59f3736aefe0ff9abf84273511071390073632 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
=pod

=head1 NAME

CONF_modules_free, CONF_modules_finish, CONF_modules_unload -
OpenSSL configuration cleanup functions

=head1 SYNOPSIS

 #include <openssl/conf.h>

 void CONF_modules_finish(void);
 void CONF_modules_unload(int all);

Deprecated:

 #if OPENSSL_API_COMPAT < 0x10100000L
 void CONF_modules_free(void)
 #endif

=head1 DESCRIPTION

CONF_modules_free() closes down and frees up all memory allocated by all
configuration modules.

CONF_modules_finish() calls each configuration modules B<finish> handler
to free up any configuration that module may have performed.

CONF_modules_unload() finishes and unloads configuration modules. If
B<all> is set to B<0> only modules loaded from DSOs will be unloads. If
B<all> is B<1> all modules, including builtin modules will be unloaded.

=head1 NOTES

Normally in versions of OpenSSL prior to 1.1.0 applications will only call
CONF_modules_free() at application exit to tidy up any configuration performed.
From 1.1.0 CONF_modules_free() is deprecated and no explicit CONF cleanup is
required at all. For more information see L<OPENSSL_init_crypto(3)>.

=head1 RETURN VALUE

None of the functions return a value.

=head1 SEE ALSO

L<conf(5)>, L<OPENSSL_config(3)>,
L<CONF_modules_load_file(3)>

=head1 HISTORY

CONF_modules_free() was deprecated in OpenSSL 1.1.0.

=head1 COPYRIGHT

Copyright 2004-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut