Static Public Member Functions
static void	Declare (string type, string source, string target)
	The Declare method declares a new name-value pair in the registry. More...

static int	GetNameRoot (string location, string name)
	The GetNameRoot method gets the root offset of a name in the registry. More...

static string	GetNameValue (string location, string name)
	The GetNameValue method gets the value of a name-value pair in the registry. More...

static int	GetPosting (int NameRoot)
	The GetPosting method gets the value of a registered name-value pair equal to a text stream as opposed to a simple string value. More...

static void	SetPosting (int NameRoot, int Posting)
	The SetPosting method sets the value of a registered name-value pair equal to a text stream as opposed to a simple string value. More...

Member Function Documentation

◆ Declare()

static void gmslLibrary.Services.Registry.Declare	(	string	type,
		string	source,
		string	target
	)

static

The Declare method declares a new name-value pair in the registry.

Parameters

type	contains the full identifier of the location of the name-value pair. This identifier consists of the names of nonterminal nodes above the pair, separated by periods. The node identifiers themselves should be simple identifiers beginning with a letter and containing only letters and numbers.
source	contains the name of the pair to be posted to the terminal location node. It may have any content. If a given pair is intended to be unique within a given location, then its name must be unique within that location only. If the registry, or the location, or the name do not yet exist, in the storage area then they are created. If they do all exist, then the previous value associated with the name is lost.
target	contains the value string to be associated with the name. It may be null which indicates that this name is to have a text stream as its associated value.

static int gmslLibrary.Services.Registry.GetNameRoot	(	string	location,
		string	name
	)

static

The GetNameRoot method gets the root offset of a name in the registry.

Parameters

location	contains the full identifier of the location of the name pair. This identifier consists of the names of nonterminal nodes above the pair, separated by periods. The node identifiers themselves should be simple identifiers beginning with a letter and containing only letters and numbers.
name	contains the name to be found.

Returns: If the name is not defined at the specified location a zero is returned; else its root offset is returned. Note that this is the same value as returned by Declare() when the name was first declared.

static string gmslLibrary.Services.Registry.GetNameValue	(	string	location,
		string	name
	)

static

The GetNameValue method gets the value of a name-value pair in the registry.

Parameters

location	contains the full identifier of the location of the name value pair. This identifier consists of the names of nonterminal nodes above the pair, separated by periods. The node identifiers themselves should be simple identifiers beginning with a letter and containing only letters and numbers.
name	contains the name of the pair. It may have any content.

Returns: The method returns the value of the pair. If the specified pair was not found or if that pair has no value associated with it, then the method returns an empty string.

static int gmslLibrary.Services.Registry.GetPosting ( int NameRoot )

static

The GetPosting method gets the value of a registered name-value pair equal to a text stream as opposed to a simple string value.

Parameters

NameRoot specifies the root offset of the pair as returned by the method Declare() or GetNameRoot().

Returns: The method returns the root offset of the text stream associated with the pair.

static void gmslLibrary.Services.Registry.SetPosting	(	int	NameRoot,
		int	Posting
	)

static

The SetPosting method sets the value of a registered name-value pair equal to a text stream as opposed to a simple string value.

Parameters

NameRoot	specifies the root offset of the pair as returned by the method Declare() or GetNameRoot().
Posting	specifies the root offset of the text stream to be associated with the pair.

The documentation for this class was generated from the following file: