Click here to return to the KiXtart HelpDesk main page...

KiXtart 2001 Manual

ReadProfileString( )

Action: Retrieves a string from an initialization file.
 
Syntax: READPROFILESTRING ("file name", "section", "key")
 
Parameters: File name

A string that names the initialization file. If this parameter does not include a full path, Windows searches for the file in the Windows directory.

Section

A string that specifies the section containing the key name. If this parameter is empty, READPROFILESTRING returns all section names in the file.

Key

A string containing the key name whose associated string is to be retrieved. If this parameter is empty, all key names in the section specified by section are returned.

Remarks: This function is provided for compatibility with 16-bit Windows based applications. Win32 based applications store initialization information in the registry.
 
Returns: Function returns a string representing the value of the specified key.
 
See Also: WriteProfileString( )
 
Example:

$dev = ReadProfileString("win.ini", "Windows", "Device")
If @ERROR = 0
  ? "Windows device = " + $dev
Endif