0c4d926858fb302c43e347ffa09bcb6f39874a04
[openssl.git] / doc / crypto / CONF_modules_load_file.pod
1 =pod
2
3 =head1 NAME
4
5  CONF_modules_load_file, CONF_modules_load - OpenSSL configuration functions
6
7 =head1 SYNOPSIS
8
9  #include <openssl/conf.h>
10
11  int CONF_modules_load_file(const char *filename, const char *appname,
12                            unsigned long flags);
13  int CONF_modules_load(const CONF *cnf, const char *appname,
14                       unsigned long flags);
15
16 =head1 DESCRIPTION
17
18 The function CONF_modules_load_file() configures OpenSSL using file
19 B<filename> and application name B<appname>. If B<filename> is NULL
20 the standard OpenSSL configuration file is used. If B<appname> is
21 NULL the standard OpenSSL application name B<openssl_conf> is used.
22 The behaviour can be cutomized using B<flags>.
23
24 CONF_modules_load() is idential to CONF_modules_load_file() except it
25 read configuration information from B<cnf>. 
26
27 =head1 NOTES
28
29 The following B<flags> are currently recognized:
30
31 B<CONF_MFLAGS_IGNORE_ERRORS> if set errors returned by individual
32 configuration modules are ignored. If not set the first module error is
33 considered fatal and no further modules are loads.
34
35 Normally any modules errors will add error information to the error queue. If
36 B<CONF_MFLAGS_SILENT> is set no error information is added.
37
38 If B<CONF_MFLAGS_NO_DSO> is set configuration module loading from DSOs is
39 disabled.
40
41 B<CONF_MFLAGS_IGNORE_MISSING_FILE> if set will make CONF_load_modules_file()
42 ignore missing configuration files. Normally a missing configuration file
43 return an error.
44
45 =head1 RETURN VALUE
46
47 These functions return 1 for success and a zero or negative value for
48 failure. If module errors are not ignored the return code will reflect the
49 return value of the failing module (this will always be zero or negative).
50
51 =head1 SEE ALSO
52
53 L<conf(5)|conf(5)>, L<OPENSSL_config(3)|OPENSSL_config(3)>,
54 L<CONF_free(3)|CONF_free(3)>, L<err(3)|err(3)>
55
56 =head1 HISTORY
57
58 CONF_modules_load_file and CONF_modules_load first appeared in OpenSSL 0.9.7.
59
60 =cut