Click or drag to resize

ModuleState Method

Manipulate a Module's state.

Namespace: WinWrap.Basic.Server
Assembly: WinWrap.Basic.Server (in WinWrap.Basic.Server.dll)
Syntax
Copy
public bool State(
	StateOperation Operation,
	string Name
)

Parameters

Operation  StateOperation
The state opertion to perform.
Name  String
The name of the state.

Return Value

Boolean
True if the operation was successful.

Implements

IModuleState(StateOperation, String)
Remarks
Use this method to affect the module's state. (Only available for non new module instances that have not been loaded using LoadModule.) The state of a module is the value of all the global variables.
Operation Description
Create Create and select a state. The "" named state is the default state created by ModuleInstance. Returns False if a state by that name already exists or name is null.
Destroy Destroy a state and then select no state. (Accessing a module instance when no state is selected is not advised.) Use a null name to destroy all the states. Returns False if a state by that name does not exist (null is allowed).
Exists Does a state exist. Returns False if a state by that name does not exist or if the name is null return False if no states exist.
IsBusy Is a state busy. Returns False if a state by that name is not busy or if the name is null return False if no states are busy.
Reset Reset and select a state. Returns False if a state by that name does not exist or name is null.
Select Select a state. Use a null name to select no state. (Accessing a module instance when no state is selected is not advised.) Returns False if a state by that name does not exist (null is allowed).
See Also