$NetBSD: NCONF_new_ex.3,v 1.5 2024/09/08 13:08:25 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "NCONF_new_ex 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NCONF_new_ex, NCONF_new, NCONF_free, NCONF_default, NCONF_load, NCONF_get0_libctx, NCONF_get_section, NCONF_get_section_names \- functionality to Load and parse configuration files manually Header "SYNOPSIS" .Vb 1 #include <openssl/conf.h> \& typedef struct { char *section; char *name; char *value; } CONF_VALUE; \& CONF *NCONF_new_ex(OSSL_LIB_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); OSSL_LIB_CTX *NCONF_get0_libctx(const CONF *conf); \& STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf, const char *name); STACK_OF(OPENSSL_CSTRING) *NCONF_get_section_names(const CONF *conf); .Ve Header "DESCRIPTION" \fBNCONF_new_ex() creates a new CONF object in heap memory and assigns to it a context libctx that can be used during loading. If the method table \fImeth is set to NULL then the default value of NCONF_default() is used.

\fBNCONF_new() is similar to NCONF_new_ex() but sets the libctx to NULL.

\fBNCONF_free() frees the data associated with conf and then frees the conf object. If the argument is NULL, nothing is done.

\fBNCONF_load() parses the file named filename and adds the values found to \fIconf. If an error occurs file and eline list the file and line that the load failed on if they are not NULL.

\fBNCONF_default() gets the default method table for processing a configuration file.

\fBNCONF_get0_libctx() gets the library context associated with the conf parameter.

\fBNCONF_get_section_names() gets the names of the sections associated with the conf as STACK_OF(OPENSSL_CSTRING) strings. The individual strings are associated with the conf and will be invalid after conf is freed. The returned stack must be freed with sk_OPENSSL_CSTRING_free().

\fBNCONF_get_section() gets the config values associated with the conf from the config section name as STACK_OF(CONF_VALUE) structures. The returned stack is associated with the conf and will be invalid after conf is freed. It must not be freed by the caller.

Header "RETURN VALUES" \fBNCONF_load() returns 1 on success or 0 on error.

\fBNCONF_new_ex() and NCONF_new() return a newly created CONF object or NULL if an error occurs.

Header "SEE ALSO" \fBCONF_modules_load_file\|(3), Header "HISTORY" \fBNCONF_new_ex(), NCONF_get0_libctx(), and NCONF_get_section_names() were added in OpenSSL 3.0. Header "COPYRIGHT" Copyright 2020-2024 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 <https://www.openssl.org/source/license.html>.