GetProfileString¶
GetProfileString retrieves a string from the specified section in an initialization file or the Windows registry.
-
ssString = GetProfileString(ssSection, ssKey) -
ssString = GetProfileString(ssSection, ssKey, ssFileName) -
ssString = GetProfileString(ssSection, ssKey, ssFileName, ssDefault)
Return Value
ssString is a scalar string to be read from the specified file. The string length is limited to 4095 characters.
Parameters
-
ssSection ssSection specifies the section containing the key name. The name of the section is case-independent;
-
ssKey ssKey is the key name of the associated string that is to be retrieved.
-
ssFileName ssFileName is a string that names the initialization file. If this string is empty (“”), GetProfileString returns data from the Windows registry.
-
ssDefault ssDefault is a default string. If the key cannot be found in the initialization file or the Windows registry, GetProfileInt returns the default string.
Comment
UniPlot uses the key HKEY_CURRENT_USER\Software\RSB\UniPlot5
in the Windows registry.
Example
If the file d:/test.ini contains the following text,
[Section]
Key=123
the call to GetProfileString returns the string "123"
* ssString = GetProfileString("Section", "Key", "d:/test.ini");
History
| Version | Description |
|---|---|
| 5.10.1 | A “esc:” prefix in the value is taken into account (see WriteProfileString) |
id-1437791