Working with Read from Ini File Process

Navigation:  How to Work with Processes > Working with the Data File Processes Group >

Working with Read from Ini File Process

Previous pageReturn to chapter overviewNext page

 

Process Purpose

 

The INI file is a key/value text file typically used for configuration and parameter setting in applications.

The "Read from Ini File" process is used to retrieve information from an INI file that is installed in the target device. This process reads the INI file and parses the information into variables.

 

 

Example of an INI File (with 2 sections)

 

[GLOBAL]

host=SERVER_ABC

port=8088

 

[BUSINESS]

location=Lisbon

name=The Priceless Shop

contact=00351 951 887 499

 

If the INI file is structured into several sections, consider using one "Read from Ini File" process for each section.

 

 

 

When you add a process, you are required to define its settings. This occurs in the process's properties window which is displayed automatically after having added the "Read from Ini File" process.

If any subsequent edition is required, double-click the process to open its properties window and enter the necessary modifications.

 

 

Proceed as follows:

 

File Name & Section

Path + File Name

Enter the name and path (inside the device) of the INI file to read OR  click and select a variable with that value.

Section

Enter the name of the section to read, within the INI file, OR  click and select a variable with that value.

Values to Read (table)

Key

Enter the key/parameter to read OR  click and select a variable with that value.

Result variable

Click to select the variable that will receive the parameter value. See To Select/Create a Variable.

If Error

Go to

Select a target location from the drop-down or the list, if an error occurs in the execution of the “Read INI File”operation. See Detail of a window below.

 

When defining a screen as a target destination (ex: via a “Go to” process), you CANNOT use variables to specify the name of that target screen. You must select the intended screen from the available drop-down/list.

 

 

Use the editing icons to the right of the table to move the rows up and down and to delete or add more rows.

 

Example

 

 

 

Detail of a window:

 

 

"S:Menu" is a screen included in the same program as the process.

"R:Routine_1" is a routine included in the same program as the process.

 

If required, click (on the upper right corner) and enter info about this process in the resulting text box. These notes will be displayed in the corresponding "Actions" tab or "Process" window (in the "Notes" field) and in the "Developer Report".

 

After filling in the required options, click to conclude or to abort the operation.

The added process is displayed in the corresponding "Actions" tab or "Process" window.

 

 

You can use relative paths to refer the file(s) you want to use in your project. See Working with Aliases.

 

 

If you want to use a label as a target destination, you can use the "Auto-Label" mechanism. This alternative to the "Set Label" process allows you to create a label in the properties window of a process - specifically, in the fields used to define target destinations (ex: the "If Error..." type fields). See To Automatically Create a Label.

 

 

Use the right-click in MCL-Designer's input boxes to access some related options as well as the general "Cut", "Copy"; "Paste"; "Search" actions (active/inactive according to the current context).

Ex: If you right-click the "Variable" input box (included in a "Conversion's" properties window), you are provided with general editing/search actions and other more specific options such as "Variable Select" (see "Variable Select"); "Variable Insert" (see "Variable Insert"); "Insert Special Character" (see To Insert Special Characters into a Control's Text Input Field) and "Localization Select" (see Localization List).

If you right-click another input box, it may provide other possibilities.