Connectivity Software User's Guide and Reference
SetState Method (SparkplugDeviceExtension)



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > SparkplugDeviceExtension Class : SetState Method
The device that will be modified and returned.

The value of this parameter cannot be null (Nothing in Visual Basic).

The state object.

The value of this parameter can be null (Nothing in Visual Basic).

Sets the arbitrary object associated with the device.
Syntax
'Declaration
 
<ExtensionAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
Public Shared Function SetState( _
   ByVal device As SparkplugDevice, _
   ByVal state As Object _
) As SparkplugDevice
'Usage
 
Dim device As SparkplugDevice
Dim state As Object
Dim value As SparkplugDevice
 
value = SparkplugDeviceExtension.SetState(device, state)
[Extension()]
[JetBrains.Annotations.NotNull()]
public static SparkplugDevice SetState( 
   SparkplugDevice device,
   object state
)
[Extension()]
[JetBrains.Annotations.NotNull()]
public:
static SparkplugDevice^ SetState( 
   SparkplugDevice^ device,
   Object^ state
) 

Parameters

device
The device that will be modified and returned.

The value of this parameter cannot be null (Nothing in Visual Basic).

state
The state object.

The value of this parameter can be null (Nothing in Visual Basic).

Return Value

Returns the device, internally modified as defined by the method.

This method never returns null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

 

Sparkplug is a trademark of Eclipse Foundation, Inc. "MQTT" is a trademark of the OASIS Open standards consortium. Other related terms are trademarks of their respective owners. Any use of these terms on this site is for descriptive purposes only and does not imply any sponsorship, endorsement or affiliation.

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