Navigation:  Actions > Files >

Read INI Action

Previous pageReturn to chapter overviewNext page

This action creates a step to read values from an INI file and store in a temporary macro.  The Loop action can be used to process multiple matching values.

 

Filename: Name of the INI file to read (required).  If no path is specified, the file in the Windows folder (%WINDIR% system macro) will be read.

 

Section: Section of the file to update (optional; retrieves all section names into array if blank).

 

Value Name: Value name to create or delete (optional; if blank, retrieves all value names in section into array).

 

Default value: The value to use if it doesn't exist (optional).

 

Macro name: The name of the temporary macro in which to store the value that was read from the file (optional, defaults to storing in the READ_INI_VALUE if not specified).

 

Do not escape special characters: Does not escape (double) special characters in the INI file values when storing in a macro.

 

Append to macro value: If checked and the macro already exists, the found text will be appended if the macro already exists.  If unchecked, any existing macro value will be replaced.

 

Log matches: If checked, all matching text found in the file will be logged when the step is built.

 

Fail step if file, section, or value not found: If checked and the file, section, or value doesn't exist, the step will fail.  If unchecked, the default value will be used.

 

Notes:

See the Files sample for an example of the Read INI action.
The READ_INI system macro can also be used to read values from an INI file.