doc/man3/NCONF_new_ex.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 NCONF_new_ex, NCONF_new, NCONF_free, NCONF_default, NCONF_load
   6 - functionality to Load and parse configuration files manually
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/conf.h>
  11
  12  CONF *NCONF_new_ex(OSSL_LIB_CTX *libctx, CONF_METHOD *meth);
  13  CONF *NCONF_new(CONF_METHOD *meth);
  14  void NCONF_free(CONF *conf);
  15  CONF_METHOD *NCONF_default(void);
  16  int NCONF_load(CONF *conf, const char *file, long *eline);
  17
  18 =head1 DESCRIPTION
  19
  20 NCONF_new_ex() creates a new CONF object in heap memory and assigns to
  21 it a context I<libctx> that can be used during loading. If the method table
  22 I<meth> is set to NULL then the default value of NCONF_default() is used.
  23
  24 NCONF_new() is similar to NCONF_new_ex() but sets the I<libctx> to NULL.
  25
  26 NCONF_free() frees the data associated with I<conf> and then frees the I<conf>
  27 object.
  28
  29 NCONF_load() parses the file named I<filename> and adds the values found to
  30 I<conf>. If an error occurs I<file> and I<eline> list the file and line that
  31 the load failed on if they are not NULL.
  32
  33 NCONF_default() gets the default method table for processing a configuration file.
  34
  35 =head1 RETURN VALUES
  36
  37 NCONF_load() returns 1 on success or 0 on error.
  38
  39 NCONF_new_ex() and NCONF_new() return a newly created I<CONF> object
  40 or NULL if an error occurs.
  41
  42 =head1 SEE ALSO
  43
  44 L<CONF_modules_load_file(3)>,
  45
  46 =head1 HISTORY
  47
  48 NCONF_new_ex() was added in OpenSSL 3.0.
  49
  50 =head1 COPYRIGHT
  51
  52 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
  53
  54 Licensed under the Apache License 2.0 (the "License").  You may not use
  55 this file except in compliance with the License.  You can obtain a copy
  56 in the file LICENSE in the source distribution or at
  57 L<https://www.openssl.org/source/license.html>.
  58
  59 =cut