Registry Plug-in

<< Click to Display Table of Contents >>

RayQC > 7.3 u2 > User Guide > Plug-ins > Internal Plug-ins 

Registry Plug-in

The Registry plug-in deals with functionality required to retrieve information about registry hives, keys, and values.

 

Function Summary

EntryExists

GetType

GetValue

KeyExists

ListOfSubkeys

Function Details

EntryExistsCheckpoint

Checks if a registry entry exists. If the entry is not found, the returned result is No, otherwise Yes.

Usable in combination with elements of type Checkpoint.

 

Input parameters

Name

Type

Description & Examples

64 Bit Architecture

boolean

default: true

 
 

The architecture specific area definition of the registry search.

 

Options:

enabled = the entry is searched within the 64bit related areas of the registry.

disabled = the entry is searched within the 32bit related areas of the registry.

Hive

formatted string

The registry hive in which RayQC searches for the key and entry defined later.

 

Options:

HKEY_CLASSES_ROOT

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

HKEY_CURRENT_CONFIG

Key

string

The name of the key in which RayQC searches for the entry defined later.

 
Example:

Software

Entry

string

The name of the entry RayQC searches for.
(Often referred to as "value", even though it seems a bit confusing that a value may have a value itself, which is why the registry plug-in searches for entries, and not values.)

 
Example:

RayPack

 

 

GetTypeMulti-OptionData Field

Gets the type of a registry key.

Usable in combination with elements of type Data Field and Multi-Option.

 

Input parameters

Name

Type

Description & Examples

64 Bit Architecture

boolean

default: true

 
 

The architecture specific area definition of the registry search.

 

Options:

enabled: the entry is searched within the 64bit related areas of the registry.

disabled: the entry is searched within the 32bit related areas of the registry.

Hive

formatted string

The registry hive in which RayQC searches for the key and entry defined later.

 

Options:

HKEY_CLASSES_ROOT

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

HKEY_CURRENT_CONFIG

Key

string

The name of the key in which RayQC searches for the entry defined later.

 
Example:

Software

Entry

string

The name of the entry RayQC searches for.
(Often referred to as "value", even though it seems a bit confusing that a value may have a value itself, which is why the registry plug-in searches for entries, and not values.)

 
Example:

RayPack

 

 

GetValueMulti-OptionData Field

Gets a registry value.

Usable in combination with elements of type Data Field and Multi-Option.

 

Input parameters

Name

Type

Description & Examples

64 Bit Architecture

boolean

default: true

 
 

The architecture specific area definition of the registry search.

 

Options:

enabled: the entry is searched within the 64bit related areas of the registry.

disabled: the entry is searched within the 32bit related areas of the registry.

Hive

formatted string

The registry hive in which RayQC searches for the key and entry defined later.

 

Options:

HKEY_CLASSES_ROOT

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

HKEY_CURRENT_CONFIG

Key

string

The name of the key in which RayQC searches for the entry defined later.

 
Example:

Software

Entry

string

The name of the entry whose value has to be returned. This is an optional parameter and if empty then it requests the default value.
(Often referred to as "value", even though it seems a bit confusing that a value may have a value itself, which is why the registry plug-in searches for entries, and not values.)

 
Example:

RayPack

 

 

KeyExistsCheckpoint

Checks if a registry key exists. If the key is not found, the returned result is No, otherwise Yes.

Usable in combination with elements of type Checkpoint.

 

Input parameters

Name

Type

Description & Examples

64 Bit Architecture

boolean

default: true

 
 

The architecture specific area definition of the registry search.

 

Options:

enabled: the entry is searched within the 64bit related areas of the registry.

disabled: the entry is searched within the 32bit related areas of the registry.

Hive

formatted string

The registry hive in which RayQC searches for the key defined later.

 

Options:

HKEY_CLASSES_ROOT

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

HKEY_CURRENT_CONFIG

Key

string

The name of the key whose existence has to be checked.

 
Example:

Software

 

 

ListOfSubkeysMulti-OptionData Field

Gets a list of subkeys for a given registry key.

Usable in combination with elements of type Data Field and Multi-Option.

 

Input parameters

Name

Type

Description & Examples

64 Bit Architecture

boolean

default: true

 
 

The architecture specific area definition of the registry search.

 

Options:

enabled: the entry is searched within the 64bit related areas of the registry.

disabled: the entry is searched within the 32bit related areas of the registry.

Hive

formatted string

The registry hive in which RayQC searches for the key and entry defined later.

 

Options:

HKEY_CLASSES_ROOT

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

HKEY_CURRENT_CONFIG

Key

string

The name of the key in which RayQC searches for the entry defined later.

 
Example:

Software

Entry

string

The name of the entry RayQC searches for.
(Often referred to as "value", even though it seems a bit confusing that a value may have a value itself, which is why the registry plug-in searches for entries, and not values.)

 
Example:

RayPack