getProfileString

getProfileString(fileName: String;
                 section:  String;
                 keyName:  String;
                 default:  String): String;

The getProfileString method of the Application class retrieves a string from the specified section in an initialization file. (The setProfileString method copies the string into the specified section of an initialization file.)

In Jade thin client mode, this method retrieves the initialization file string from the specified initialization file on the presentation client. (Use the getProfileStringAppServer method of the Application class to retrieve the string from the initialization file on the application server or process.getProfileString to retrieve the string from the initialization file of the process of the receiver.)

The parameters for the getProfileString method are listed in the following table.

Parameter	Specifies the …
fileName	Initialization file. If you set this parameter to windows, the win.ini file is used. If it does not contain a full path to the file, Windows searches for the file in the Windows directory.
section	Initialization file section containing the key (parameter) name.
keyName	Name of the key (parameter) whose associated string is to be retrieved.
default	Default value for the specified key if the key cannot be found in the initialization file or if the specified key is found in the initialization file but has the special value <default>.

You can return all initialization file sections or all parameters in a section, by using the JadeProfileString category global constants listed in the following table.

Global Constant	Specified in the…	Returns all…
ProfileAllKeys	keyName parameter	Key (parameter) strings in the initialization file section, separated by spaces
ProfileAllSections	section parameter	Initialization file sections, separated by spaces

You can use this method to retrieve a string from a two‑level section name (prefixed with a unique identifier) within a Jade initialization file shared by multiple programs on the same host. For details, see "Two-Level Section Names" under "Format of the Jade Initialization File", in the Jade Initialization File Reference.

The following example shows the use of the getProfileString method to determine the server for the current Jade initialization file.

vars
    server : String;
begin
    server := app.getProfileString(app.getIniFileName, "JadeClient",
                                   "ServerName", null);
    write "server name is " & server;
end;