Connectivity Software User's Guide and Reference
AutoGeneratedHostId Property



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug.System Namespace > EasySparkplugSystem Class : AutoGeneratedHostId Property
The host ID that will be used when a host application component is created in this Sparkplug system, and no specific host ID is given.
Syntax
'Declaration
 
<JetBrains.Annotations.NotNullAttribute()>
Public ReadOnly Property AutoGeneratedHostId As String
'Usage
 
Dim instance As EasySparkplugSystem
Dim value As String
 
value = instance.AutoGeneratedHostId
[JetBrains.Annotations.NotNull()]
public string AutoGeneratedHostId {get;}
[JetBrains.Annotations.NotNull()]
public:
property String^ AutoGeneratedHostId {
   String^ get();
}

Property Value

The value represents a Sparkplug host ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus) and '#' (number sign).

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

The default value of this property is "" (String.Empty).

Remarks

The default configuration assures that the system auto-generates a host ID that is conformant with the Sparkplug syntactic rules. It also attempts to make it unique within the Sparkplug system.

The auto-generated host ID is created using the HostIdTemplateString.

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

 

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