State Object

The Stateobject is a named instance of the VarSetobject that contains values set through a MOM rule with the Update a State Variableresponse type. As a response to an event, alert, or performance measurement, you can save and edit state information in the Stateobject. You can then access this state information from scripts.

There are different types of state operations. Most state operations edit a variable by incrementing it, decrementing it, or setting it to a specific value. State operations include the following:

• Increment a variable value
• Decrement a variable value
• Set a variable value to property
• Set a variable value to text
• Set a variable value to number

These operations make the variable specified in the State variable namefield available to scripts through the Stateobject.

The Store the last N occurrencesoperation creates the following variables with the state variable root:

• State_Variable_Root.size: Specifies the number of occurrences stored. This value is equal to the value specified in the Number of occurrencesfield.
• State_Variable_Root.first: Specifies which State_Variable_Root.N variable contains the earliest occurrence of the variable. If State_Variable_Root.first equals 4, then the earliest occurrence of the variable is stored in State_Variable_Root.4.
• State_Variable_Root.last: Specifies which State_Variable_Root.N variable contains the latest occurrence of the variable. If State_Variable_Root.last equals 2, then the latest occurrence of the variable is stored in State_Variable_Root.2.
• State_Variable_Root.N: Specifies each of the occurrences of the variable. N can be 1 to the value specified in the Number of occurrencesfield. The occurrences cycle through the N variables overwriting the oldest occurrence. Use the .first and .last variables to keep track of the order of occurrences.

Set the operation, values, and name and root fields for state operations with the State Variable Update Operationwindow.

The following example shows how to access the number of times an event occurred after setting a state response to increment the LogonViolations.Count state variable name.

[VBScript] 
Function GetNumberOfLogonViolations()
	Dim vntCount

	vntCount = State.get("LogonViolations.Count")
	GetNumberOfLogonViolations = CLng(vntCount)
End Function

The following example shows how to access the last occurrence of the logon domain after setting a state response to record the last 50 occurrences of the Logging Domain variable with the LogonViolations.LoggingDomain state variable root.

[VBScript] 
Function GetLastDomain()
	Dim vntLastDomain, vntLastOccurrence

	vntLastOccurrence =
State.get("LogonViolations.LoggingDomain.last")
	vntLastDomain = State.get("LogonViolations.LoggingDomain."
& vntLastOccurrence)
	GetLastDomain = CStr(vntLastDomain)
End Function

Requirements

Windows NT/2000: Requires Windows 2000 or later
Version: Requires MOM 1.0 SP1

See Also

VarSet Object

Did you find this information useful? Please send your suggestions and comments about the documentation to momsdk@microsoft.com.