You are here: Function Reference > Alphabetical Listing > L > LoadINIFile

LoadINIFile

Use this procedure/function to load an INI file into cache memory.

Syntax

LoadINIFile (Context, File)

Parameter

Description

Context

(Optional) A name (valid string) that will be associated to the set of INI control groups and options contained in the physical file.

File

Enter the name of the INI file to load. If you omit the extension, the system assumes it is INI. The system searches in the current directory, or uses a full path name if you specify one

This procedure returns success (1) if no error occurred during its execution, otherwise a failure (0) is returned.

If you specify a context name, that name can be used by other INI functions to reference the loaded set of INI control groups and options.

Example

Here are some examples:

Procedure

Result

Explanation

LoadINIFile (,"DALRun");

The INI control groups and options can now be referenced by executing modules.

The INI file is loaded into cache memory. Execution of this procedure assumes the file extension is INI.

LoadINIFile ("Run_process", "DALRun.ini");

The INI control groups and options can now be referenced by executing modules. This set of INI control groups and options can now be referenced by other INI functions, using the tag Run_process.

The INI file is loaded into cache memory.

See also