NodePath Property (_NodeDescriptor)

Contains node path (empty string for the root, null reference if unknown). Only used with OPC XML.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<CanBeNullAttribute()>
Property NodePath As String

'Usage
 
Dim instance As _NodeDescriptor
Dim value As String
 
instance.NodePath = value
 
value = instance.NodePath

[CanBeNull()]
string NodePath {get; set;}

[CanBeNull()]
property String^ NodePath {
   String^ get();
   void set (    String^ value);
}

Remarks

Not to be confused with the BrowsePath, or the access path (only in OPC-DA 1.0, and quite rare).

This is called ItemPath in the OPC XML-DA Specification. "OPC XML-DA addresses OPC Items via ItemPath, and ItemName."

ItemPath: "A portion of the namespace pointing to the data. The ItemPath is server specific and the client should not make any implications about its content, structure, or consistency across servers. ItemPath may or may not imply node, or server.
If an XML-DA server was front ending a DA based server, then an example could be: \\NODE\OPC.DAServer.2.
ItemPath is a hierarchical parameter. >br/> If ItemPath is Blank or missing at all levels of the hierarchy, then the ItemName is expected to be a fully qualified name."

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

Requirements

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

Reference

_NodeDescriptor Interface
_NodeDescriptor Members

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.