get-registry(2)

[Home] [Commands] [Variables] [Macro-Dev] [Glossary]

NAME

get-registry - Retrieve a node value from the registry.
set-registry - Modify a node value in the registry.

SYNOPSIS

get-registry "root" "subkey"
set-registry "root" "subkey" "value"

DESCRIPTION

get-registry retrieves the value of a node defined by root/subkey from the registry into the variable $result(5).

The node name is specified in two components, typically required when iterating over a registry tree, where the root component is static and the subkey is dynamic, subkey may be specified as the null string ("") if an absolute registry path is specified.

set-registry adds (or modifies) a new value to the registry. root is the root of the new entry and MUST exist or the call fails. subkey is the node name (or path) if the path does not exist then it is created. value is the value to assign to the node.

DIAGNOSTICS

get-registry fails if the node does not exist, otherwise the registry string is returned in $result(5).

set-registry fails if the root node does not exist.

EXAMPLE

The following call

set-registry "/history" "foo/win32/printer" "foo-bar"

constructs a registry hierarchy of the form:-

"history" { 
  "foo" { 
    "win32" { 
      "printer"="foo-bar"; 
    } 
  } 
}

The value of the registry node may be retrieved using:-

get-registry "/history" "foo/win32/printer"