CRegistry:new


The new method constructs a new instance of a CRegistry object. After creating or opening a key, you can use the Get() and Set() methods to access its values.

Syntax

R = CRegistry:new()

R = CRegistry:new( sKeyName )

R = CRegistry:new( CRegistry2 )

where

    The first form, with no argument, creates a new CRegistry object that is not attached to a registry key.

    sKeyName is the name of a registry key to be opened. This is equivalent fo the Open method.

    CRegistry2 is an existing CRegistry object which is opened by the new CRegistry object.

    R is the new CRegistry object. On failure, nil is returned.

 

Two overloads are provided for this method. They open a registry key or create separate access to the same key. You must provide a key name as a parameter. If the named key exists it is opened. If it does not exist it is created. A new key will not be saved to the Registry unless you use one of the Set() methods. The new method is equivalent to the Open method, so you can use either the new / delete pair or the Open / Close pair to open and close the key.

Example

The following script opens a key and retrieves the radius parameter. If the radius value does not exist in the Registry, the default value of 5.2 is returned.

R = CRegistry:new( "(Script) Test" )

-- open registry key "(Script) Test"

r = R:GetNum("radius", 5.2 )

-- fetch the "radius" value, default to 5.2

 

-- return value if it exists, else return 5.2

Printf("Rad= %lg", r )

-- result: Rad= 15.125 (already exists)

R:delete()

-- close access to the key

Related Topics

Open

delete

CRegistry class