OPC Studio User's Guide and Reference
State Property (_OperationResult)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.OperationModel.ComTypes Namespace > _OperationResult Interface : State Property
Gets or sets the arbitrary object associated with the operation.
Syntax
'Declaration
 
<CanBeNullAttribute()>
Property State As Object
'Usage
 
Dim instance As _OperationResult
Dim value As Object
 
instance.State = value
 
value = instance.State
[CanBeNull()]
object State {get; set;}
[CanBeNull()]
property Object^ State {
   Object^ get();
   void set (    Object^ value);
}

Property Value

This value of this property can be null (Nothing in Visual Basic).

The default value of this property is null.

Remarks

The State object is valid independent of whether the operation has succeeded or failed. It is a copy of the State object passed to the operation as its input. The semantics of this value depends on the application.

The getter method of this property is pure, i.e. it does not have observable side effects.

This method or property does not throw any exceptions, aside from execution exceptions such as System.Threading.ThreadAbortException or System.OutOfMemoryException.

This member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also