Registry Action Icon

Registry

 

Declaration

<AMREGISTRY ACTION="text [options]" TYPE="string" KEY="text" VALUE="text" VALUEDATA="text" RESULTVARIABLE="text">

See Also

Change Printer | Display | Empty Recycle Bin | End Process | Get Process Information | Get Volume Information | Log Event | Print | Registry | Run

Description

Modifies the Windows Registry according to the settings you specify.

IMPORTANT: Because the registry stores important system configuration settings, improper use of this action can cause irreversible damage to your operating system. Use this action with caution and always backup your registry.

Practical Usage

Used to store, retrieve, modify or delete settings either for the task itself or for another application. For example, you may wish a task to save data collected during one session so that it can be retrieved and used the next time the task is run. In another possible use, you may wish to collect data about an external application by retrieving it from the applications registry branch. Additionally, since the registry contains features that improve system integrity, this action can also Ideal tool .

Using the HKEY_CURRENT_USER section of the registry is especially useful for storing "user-specific" data because each user on the Windows system has his/her own HKEY_CURRENT_USER structure that Windows loads in at log on, thus the data can be different depending on which user is logged on to the system. Use HKEY_LOCAL_MACHINE for settings that are not "user-specific" and are "global" to the machine. This action is intended for advanced users, improper use could damage your Windows installation and or the installation of other software on your system.

Parameters

General Properties

Property

Type

Req'd

Default

Markup

Description

Action to take

Text (options)

Yes

Read value data

ACTION="write_value"

The action that should be performed. The available options are:

  • Read value data: Read a value from the registry.

  • Delete value: Delete a value from the registry.

  • Rename value: Rename a value in the registry.

  • Create key: Create a key in the registry. Multiple levels can be specified - any that do not exist will be created.

  • Delete key: Delete a key in the registry. Any sub-keys will also be deleted - BE CAREFUL USING THIS OPTION

  • Rename key: Rename a key in the registry.

  • Create/change value data: Used to write a value and optional data to the registry. Necessary keys will be automatically created.

Type

Text (options)

No

String

TYPE="STRING"

The data type to use. This parameter is available only if the Action to take parameter is set to Create/change value data. The available options are:

  • String (default)

  • DWORD

Registry Key

Text

Yes

(Empty)

KEY="HKEY_CURRENT_USER\Software

\Network Automation\AutoMate 9\\AMSERVICES"

The registry key (folder) that should be acted upon. What takes place in the key depends on which option was selected in the Action to take parameter.

NOTE: Use the Folder icon to navigate to the desired registry key, value name and optionally, value data.

Populate Variable with Value Data

Text

Yes

(Empty)

RESULTVARIABLE="myvarname"

The name of an already created variable which should be populated with the value that is read from the registry. This parameter is valid only if the Read value data option is selected in the Action to Take parameter.

Value Name

Text

Yes

(Empty)

VALUE="Width"

The registry value that should be acted upon.

Value Data

Text

Yes

(Empty)

VALUEDATA="600"

The Registry value data to write. Valid only if the Create\Change Value Data option is selected in the Action to Take parameter. The Registry Key and Value Name must also be specified for proper functioning.

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab properties lets you instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Additional Notes

Expressions, Variables & Functions

A percent sign is used as a special character in AutoMate to indicate the beginning and end of an expression. This allows variables, functions and other expressions to be entered in any text parameter of a task's properties. For example: %1+1% inside a task will resolve to 2 at runtime. A more elaborate example is %FileDateTime(myFile)% which results to the date/time of myFile. To help construct expressions, you can open Expression Builder by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on functions

More on extended functions
More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

 

Description: Reads registry value data and populates a variable with the results.

 

<AMVARIABLE NAME="theValueData"></AMVARIABLE>

<AMREGISTRY ACTION="read_value" KEY="HKEY_CURRENT_USER\Software\Network Automation\AutoMate 9\TaskBuilder" VALUE="MaxOutputWindowLines" RESULTVARIABLE="theValueData" />

<AMSHOWDIALOG MESSAGE="The value data is %theValueData%." />

 

↑ Top of Page