getString

getString

Retrieves a value from a .ini file.

Method of

WinProfile object

Syntax

String getString ( String section, String key);

Parameters

The method has the following parameters:

section

Section in the file, such as "boot" or "drivers".

key

The key in that section whose value to return.

Returns

The value of the key or an empty string if none was found.

Description

The getString method is similar to the Windows API function getPrivateProfileString. Unlike that function, this method does not support using a null key to return a list of keys in a section.

Example

To get the name of the wallpaper file from the desktop section of the win.ini file, use this call:

ini = getWinProfile (getFolder("Windows"), "win.ini");
var wallpaperValue = ini.getString ("Desktop", "Wallpaper");