Connectivity Software User's Guide and Reference
DeviceId Property (SparkplugArguments)



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug.OperationModel Namespace > SparkplugArguments Class : DeviceId Property
The Sparkplug device ID of the device to which the operation applies. Empty string if the operation application to an edge node.
Syntax
'Declaration
 
<JetBrains.Annotations.NotNullAttribute()>
Public Property DeviceId As String
'Usage
 
Dim instance As SparkplugArguments
Dim value As String
 
instance.DeviceId = value
 
value = instance.DeviceId
[JetBrains.Annotations.NotNull()]
public string DeviceId {get; set;}
[JetBrains.Annotations.NotNull()]
public:
property String^ DeviceId {
   String^ get();
   void set (    String^ value);
}

Property Value

The value represents a Sparkplug device ID, or a filter for Sparkplug device IDs. It must be a string with valid UTF-8 characters except for the reserved character '/' (forward slash). Characters '+' (plus) and '#' are filters, and can only be used when they are the single character in the string.

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

The default value of this property is "#".

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

 

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