Click or drag to resize

IntegerVariableAPI Class

Provides access to integer variables, which can be created and stored on the card. Furthermore, they can be retrieved and/or modified via control commands, and be referenced by various flow-control list commands.
Inheritance Hierarchy
SystemObject
  RAYLASE.SPICE3.ClientLibSpice3API
    RAYLASE.SPICE3.ClientLibIntegerVariableAPI

Namespace: RAYLASE.SPICE3.ClientLib
Assembly: RAYLASE.SPICE3.ClientLib (in RAYLASE.SPICE3.ClientLib.dll) Version: 3.4.1
Syntax
C#
public class IntegerVariableAPI : Spice3API

The IntegerVariableAPI type exposes the following members.

Methods
 NameDescription
Public methodCreate Creates a variable with the specified name on the card.
Public methodDecrementValue Decrements the current value of the referenced integer variable on the card by one.
Public methodDelete Deletes the referenced variable on the card.
Public methodExists Checks whether the referenced variable exists on the card.
Public methodGetStoredNames Returns a list of all variables that are currently stored on the card's local storage.
Public methodGetValue Retrieves the current value of the referenced integer variable from the card.
Public methodIncrementValue Increments the current value of the referenced integer variable on the card by one.
Public methodLoad Loads the referenced variable from the card's local storage.
Public methodSetValue Sets the specified value of the referenced integer variable on the card.
Public methodStore Stores the referenced variable in the card's local storage for later (re-)loading.
Top
See Also