xcall MIAMEX, MX_GETREG, key, subkey, name, value

(Windows/ATE only) MX_GETREG allows you to retrieve values from the system Registry. Also see MIAMEX 138: Registry operations, which offers a more extensive set of registry access capabilities.

Parameters

key  (Num or B,4)

must be one of the following specified values:

Hex-Decimal Values

subkey  (String)

is the sub key within the specified key section of the Registry. This may have multiple parts, e.g. "Software\Microsoft\MediaPlayer\Player\RecentFileList".

name  (String)

is the name of the particular value to look for within the specified subkey. You may specify a blank string to get the default value. (Many subkeys have only a default value.) For the subkey example given above, the likely names will be "File0", "File1", etc.

value  (type corresponding to registry data type)

will return the value of the specified item. The parameter type specified must match the type of the registry item: use B,4 for REG_DWORD items, string for REG_SZ and REG_EXPAND_SZ items, unformatted for other types. Dynamic strings (S,0) are allowed, but the internal maximum size is 1024; data items larger than 1024 bytes will come back as null strings. Environment variables, found in registry items of type REG_EXPAND_SZ, will be expanded. See History for details.

Comments

In the case of ATE (with one of the GUI-enabled "G" emulations), the request will be automatically forwarded to the ATE client, even when the server is Windows (i.e. ATSD). To query the server-side registry, use MX_REGISTRY instead.

History

2012 April, A-Shell 6.0.1248.3:  Add automatic expansion of environment variables in REG_EXPAND_SZ items.  Increase maximum supported string length from 256 to 1024.

2006 April, A-Shell 4.9.963:  This function is now supported in ATE.