set-registry(2)

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

NAME

set-registry - Modify a node value in the registry.

SYNOPSIS

set-registry "root" "value"
2 set-registry "root" "new-name"

INTRODUCTION

The registry is a hierarchical tree of node names optionally with associated node values that is used for storing and retrieving values. The registry mechanism is used for saving and retrieving persistent user information between sessions.

DESCRIPTION

set-registry adds a new value or modifies an existing value in the registry. root is an absolute path node name to the new entry. The first path component MUST exist or the call fails, subsequent path components (a `/' separated path) are created if they do not already exist. value is the value to assign to the node.

If a numeric argument of 2 is specified the root is renamed to new-name, the root must exist or the call fails. If the new-name contains a path (i.e. "new/path/name") the registry node is moved to the new path which must be an existing absolute path, i.e. not relative to its current location.

The value assigned to a node with set-registry may be retrieved using &reg(4).

EXAMPLE

The following call (where the registry node /history already exists):

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

constructs a registry hierarchy of the form:-

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

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

&reg "/history/foo/windows/printer"

which would return the value "foo-bar".

HISTORY

The get-registry(2) command was removed in January 2005 in preference to the &reg(4) function, the existing get command was never used.