GetProfileString

Accesses a Settings file (.ini) and adds a value in that file to your Export file.

Syntax

bool GetProfileString (StrParam)

Parameters

  1. The [Section] within the Settings file.
  2. The Key entry within the section, with the value you want to retrieve.
  3. The name of the Settings file.

Returns

False if the settings file cannot be found. Otherwise, True. If the settings file can be found but the key entry cannot be found within the file, this action will return True.

Level

All levels.

Details

Accesses a Settings file (.ini), locates the specified key and adds the value of the key to your Export file. If the key cannot be read from the settings file, an empty string will be written to the export. If the settings file cannot be found, nothing will be written to the export.
Important: The action assumes that the Settings file resides in the current batch directory. If you want the INI file to reside in the Batches directory, specify your file name with a relative path like this: ..\myfile.ini.
Example
GetProfileString("General,MyValue,Batch.ini")
Parent topic: Export actions