ReadRegistry

Top  Previous  Next

 

ReadRegistry

 

Syntax

ReadRegistry([in] RootFolderType, [in] KeyFolder, [in] KeyName, [out] KeyValueVar);

 

Description

To read a string from a registry.

 

Parameters

       RootFolderType

               The root registry folder to read from. There are 5 possible values:

                       "HKLM" = Reading from a root folder HKEY_LOCAL_MACHINE

                       "HKCU" = Reading from a root folder HKEY_CURRENT_USER

                       "HKCC" = Reading from a root folder HKEY_CURRENT_CONFIG

                       "HKCR" = Reading from a root folder HKEY_CLASSES_ROOT

                       "HKUS" = Reading from a root folder HKEY_USERS

       KeyFolder

               The path to the key folder to read from                

       KeyName

               They registry key name to read from

       KeyValueVar

               The variable name to receive the read string

 

Return

       1 = success

       0 = failed

       -1 = FSCommands cannot be found

 

Example

 

FSCommand("ReadRegistry", "HKLM,Software\\IncrediTools,InstallPath,ReadVarName");

 

This will read a registry key located at HKEY_LOCAL_MACHINE\Software\IncrediTools\InstallPath into _root.ReadVarName flash variable.