Click here for NewsObjects Overview
ReadKey Method (Utility Control)
Windows - Visual C++


Description
The ReadKey method reads a value from the initialization (.ini) file or the Windows registry, depending on the value of the IniType property.

Syntax
long result = ReadKey(LPCTSTR szSection, LPCTSTR szEntry);

The ReadKey syntax has these parts:

 Part

Description

section

A String containing the section name of the .ini file or the Windows registry.

entry

A String containing the entry name within the section.

result

Return value. A long integer containing 0 if successful and 1 if not.

Remarks
The value of the IniType property determines whether the ReadKey method reads from the initialization(.ini) file or the Windows registry. If IniType is 0, it indicates that ReadKey should read from the initialization(.ini) file. If IniType is 1, it indicates that ReadKey should be read from the Windows registry. The IniValue property indicates either the initialization(.ini) file name or the Windows registry key value that should be accessed, depending on the value of the IniType property.

After ReadKey is called, the value that was read is stored in the KeyValue property.

See Also:  KeyValue WriteKey IniValue IniType

Back to: Utility Methods