Tree

Description:

[ CCode ( cname = "aug_init" ) ]
public Tree (string? root = null, string? loadpath = null, InitFlags flags = NO_MODL_AUTOLOAD)

Initialize the library.

The Vala binding uses InitFlags.NO_MOD_AUTOLOAD as the default flag to make a quick initialization of the library. Otherwise the library can take several seconds to initialize because it will load all lenses and any corresponding files marked for auto-loading. With InitFlags.NO_MOD_AUTOLOAD transform () and load () need to be used to identify the lens and configuration file to load.

Parameters:

root	the filesystem root. If ROOT is NULL, use the value of the environment variable AUGEAS_ROOT. If that doesn’t exist, use "/".
loadpath	a colon-separated list of directories that modules should be searched in. This is in addition to the standard load path and the directories in AUGEAS_LENS_LIB
flags	a bitmask made up of values from InitFlags. The flag InitFlags.NO_ERR_CLOSE can be used to get more information on why initialization failed. If it is set in flags, the caller must check that error () returns ErrorCode.NOERROR before using the returned augeas handle for any other operation. If the handle reports any error, the caller should only call the error functions and close () on this handle.

Returns:

a handle to the Augeas tree upon success. If initialization fails, returns NULL if InitFlags.NO_ERR_CLOSE is not set in flags. If InitFlags.NO_ERR_CLOSE is set, might return an Augeas handle even on failure. In that case, caller must check for errors using error () , and, if an error is reported, only use the handle with the error functions and close ().