diff options
author | Matt Caswell <matt@openssl.org> | 2020-09-24 10:56:03 +0100 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2020-10-01 09:25:20 +0100 |
commit | 746f3674896845460946ace7e963e52b547fbf35 (patch) | |
tree | 3524d555baa83495e8b19a0bd279e8a3b42807c9 /doc/man3/NCONF_new_ex.pod | |
parent | d8652be06e2778e8898453a391deb7253e1a35a2 (diff) |
Fix some things the rename script didn't quite get right
The previous commit ran an automated rename throughout the codebase.
There are a small number of things it didn't quite get right so we fix
those in this commit.
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/12970)
Diffstat (limited to 'doc/man3/NCONF_new_ex.pod')
-rw-r--r-- | doc/man3/NCONF_new_ex.pod | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/doc/man3/NCONF_new_ex.pod b/doc/man3/NCONF_new_ex.pod new file mode 100644 index 0000000000..2de14b4f4e --- /dev/null +++ b/doc/man3/NCONF_new_ex.pod @@ -0,0 +1,59 @@ +=pod + +=head1 NAME + +NCONF_new_ex, NCONF_new, NCONF_free, NCONF_default, NCONF_load +- functionality to Load and parse configuration files manually + +=head1 SYNOPSIS + + #include <openssl/conf.h> + + CONF *NCONF_new_ex(OPENSSL_CTX *libctx, CONF_METHOD *meth); + CONF *NCONF_new(CONF_METHOD *meth); + void NCONF_free(CONF *conf); + CONF_METHOD *NCONF_default(void); + int NCONF_load(CONF *conf, const char *file, long *eline); + +=head1 DESCRIPTION + +NCONF_new_ex() creates a new CONF object in heap memory and assigns to +it a context I<libctx> that can be used during loading. If the method table +I<meth> is set to NULL then the default value of NCONF_default() is used. + +NCONF_new() is similar to NCONF_new_ex() but sets the I<libctx> to NULL. + +NCONF_free() frees the data associated with I<conf> and then frees the I<conf> +object. + +NCONF_load() parses the file named I<filename> and adds the values found to +I<conf>. If an error occurs I<file> and I<eline> list the file and line that +the load failed on if they are not NULL. + +NCONF_default() gets the default method table for processing a configuration file. + +=head1 RETURN VALUES + +NCONF_load() returns 1 on success or 0 on error. + +NCONF_new_ex() and NCONF_new() return a newly created I<CONF> object +or NULL if an error occurs. + +=head1 SEE ALSO + +L<CONF_modules_load_file(3)>, + +=head1 HISTORY + +NCONF_new_ex() was added in OpenSSL 3.0. + +=head1 COPYRIGHT + +Copyright 2020 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (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 |