Parses a string containing an absolute browse path, and returns a corresponding browse path object.
Syntax
Parameters
- value
- The string containing the absolute browse path to be parsed.
The value of this parameter can be null
(Nothing
in Visual Basic).
Return Value
Returns the browse path object parsed from the input value.
Because there is an implicit conversion from OpcLabs.EasyOpc.UA.Navigation.UABrowsePath to OpcLabs.EasyOpc.UA.UANodeDescriptor, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use the returned OpcLabs.EasyOpc.UA.Navigation.UABrowsePath in any place where the OpcLabs.EasyOpc.UA.UANodeDescriptor is expected as input, and the corresponding node descriptor will be constructed automatically.
This method never returns null
(Nothing
in Visual Basic).
Exceptions
Example
COM
// Parses an absolute OPC-UA browse path and displays its starting node and elements.
//
// Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .
// OPC client and subscriber examples in Object Pascal (Delphi) on GitHub: https://github.com/OPCLabs/Examples-QuickOPC-OP .
// Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own
// a commercial license in order to use Online Forums, and we reply to every post.
class procedure Parse.Main;
var
BrowsePath: _UABrowsePath;
BrowsePathElement: _UABrowsePathElement;
BrowsePathParser: OpcLabs_EasyOpcUA_TLB._UABrowsePathParser;
Count: Cardinal;
Element: OleVariant;
ElementEnumerator: IEnumVariant;
begin
BrowsePathParser := CoUABrowsePathParser.Create;
try
BrowsePath := BrowsePathParser.Parse('[ObjectsFolder]/Data/Static/UserScalar');
except
on E: EOleException do
begin
WriteLn(Format('*** Failure: %s', [E.GetBaseException.Message]));
Exit;
end;
end;
// Display results
WriteLn('StartingNodeId: ', BrowsePath.StartingNodeId.ToString);
WriteLn('Elements:');
ElementEnumerator := BrowsePath.Elements.GetEnumerator;
while (ElementEnumerator.Next(1, Element, Count) = S_OK) do
begin
BrowsePathElement := IUnknown(Element) as _UABrowsePathElement;
WriteLn(BrowsePathElement.ToString);
end;
// Example output:
// StartingNodeId: ObjectsFolder
// Elements:
// /Data
// /Static
// /UserScalar
end;
// Parses an absolute OPC-UA browse path and displays its starting node and elements.
//
// Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .
// OPC client and subscriber examples in PHP on GitHub: https://github.com/OPCLabs/Examples-QuickOPC-PHP .
// Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own
// a commercial license in order to use Online Forums, and we reply to every post.
$BrowsePathParser = new COM("OpcLabs.EasyOpc.UA.Navigation.Parsing.UABrowsePathParser");
try
{
$BrowsePath = $BrowsePathParser->Parse("[ObjectsFolder]/Data/Static/UserScalar");
}
catch (com_exception $e)
{
printf("*** Failure: %s\n", $e->getMessage());
exit();
}
// Display results
printf("StartingNodeId: %s\n", $BrowsePath->StartingNodeId);
printf("Elements:\n");
for ($i = 0; $i < $BrowsePath->Elements->Count; $i++)
{
printf("%s\n", $BrowsePath->Elements[$i]);
}
// Example output:
// StartingNodeId: ObjectsFolder
// Elements:
// /Data
// /Static
// /UserScalar
REM Parses an absolute OPC-UA browse path and displays its starting node and elements.
REM
REM Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .
REM OPC client and subscriber examples in Visual Basic on GitHub: https://github.com/OPCLabs/Examples-QuickOPC-VB .
REM Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own
REM a commercial license in order to use Online Forums, and we reply to every post.
Private Sub Parse_Main_Command_Click()
OutputText = ""
Dim BrowsePathParser As New UABrowsePathParser
On Error Resume Next
Dim browsePath As UABrowsePath
Set browsePath = BrowsePathParser.Parse("[ObjectsFolder]/Data/Static/UserScalar")
If Err.Number <> 0 Then
OutputText = OutputText & "*** Failure: " & Err.Source & ": " & Err.Description & vbCrLf
Exit Sub
End If
On Error GoTo 0
' Display results
OutputText = OutputText & "StartingNodeId: " & browsePath.StartingNodeId & vbCrLf
OutputText = OutputText & "Elements:" & vbCrLf
Dim BrowsePathElement: For Each BrowsePathElement In browsePath.Elements
OutputText = OutputText & BrowsePathElement & vbCrLf
Next
' Example output:
'StartingNodeId: ObjectsFolder
'Elements:
'/Data
'/Static
'/UserScalar
End Sub
Rem Parses an absolute OPC-UA browse path and displays its starting node and elements.
Rem
Rem Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .
Rem OPC client and subscriber examples in VBScript on GitHub: https://github.com/OPCLabs/Examples-QuickOPC-VBScript .
Rem Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own
Rem a commercial license in order to use Online Forums, and we reply to every post.
Option Explicit
Dim BrowsePathParser: Set BrowsePathParser = CreateObject("OpcLabs.EasyOpc.UA.Navigation.Parsing.UABrowsePathParser")
On Error Resume Next
Dim BrowsePath: Set BrowsePath = BrowsePathParser.Parse("[ObjectsFolder]/Data/Static/UserScalar")
If Err.Number <> 0 Then
WScript.Echo "*** Failure: " & Err.Source & ": " & Err.Description
WScript.Quit
End If
On Error Goto 0
' Display results
WScript.Echo "StartingNodeId: " & BrowsePath.StartingNodeId
WScript.Echo "Elements:"
Dim BrowsePathElement: For Each BrowsePathElement In BrowsePath.Elements
WScript.Echo BrowsePathElement
Next
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