Please enable JavaScript to view this site.

ESL Documentation

ESLREG Subroutine

Retrieve a string value from the specified Windows Registry entry.

 

ReadRegString(integer:RegID_IV, 

string:ValueName_SV, 

string:Target_SV)

Parameters

RegID_IV

An integer variable that holds the handle to the currently open registry key, as opened by OpenReg.

 

ValueName_SV

The name of the value to be queried. If a null string is used, the default value for the key is used, although you must have previously set the default value using WriteRegString or WriteRegBinary.

 

Target_SV

A string variable that will hold the character or binary value from the registry entry.

Returns

One of the following codes will be returned in the pseudo variable, "errorlevel":

REG_E_ERRORFREE

Operation was successful.

REG_E_NOTFOUND

Registry entry not found.

REG_E_BADHANDLE

The Key Handle being passed is invalid.

REG_E_WRONGDATATYPE

Data in Registry is the wrong type.

REG_E_MEMORY

Cannot allocate memory to store string.

Description

This routines retrieves the character or binary value the specified Windows registry entry. The entry type must be REG_SZ (i.e. Null terminated character array) or REG_BINARY (i.e. Binary data array), as created when using WriteRegString or WriteRegBinary.