OPC Studio User's Guide and Reference
ParseRelative Method (BrowsePathParser)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Navigation.Parsing Namespace > BrowsePathParser Class : ParseRelative Method
The string containing the relative browse path to be parsed.

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

Parses a string containing a relative browse path, and returns a corresponding browse path element collection.
Syntax
'Declaration
 
<NotNullAttribute()>
Public Function ParseRelative( _
   ByVal value As String _
) As StringCollection
'Usage
 
Dim instance As BrowsePathParser
Dim value As String
Dim value As StringCollection
 
value = instance.ParseRelative(value)
[NotNull()]
public StringCollection ParseRelative( 
   string value
)
[NotNull()]
public:
StringCollection^ ParseRelative( 
   String^ value
) 

Parameters

value
The string containing the relative browse path to be parsed.

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

Return Value

Returns a collection of browse path elements corresponding to the input string.

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

The individual elements of the returned value are never 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.

The browse path cannot be parsed.
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