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



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

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

If successful, an original collection of browse path elements, expanded by elements corresponding to the input string.

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

The individual elements of the parameter value cannot be null (Nothing in Visual Basic).

Attempts to parse a string containing a relative browse path.
Syntax
'Declaration
 
<CanBeNullAttribute()>
<PureAttribute()>
Public Function TryParseRelative( _
   ByVal value As String, _
   ByVal browseNames As StringCollection _
) As IStringParsingError
'Usage
 
Dim instance As BrowsePathParser
Dim value As String
Dim browseNames As StringCollection
Dim value As IStringParsingError
 
value = instance.TryParseRelative(value, browseNames)
[CanBeNull()]
[Pure()]
public IStringParsingError TryParseRelative( 
   string value,
   StringCollection browseNames
)
[CanBeNull()]
[Pure()]
public:
IStringParsingError^ TryParseRelative( 
   String^ value,
   StringCollection^ browseNames
) 

Parameters

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

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

browseNames
If successful, an original collection of browse path elements, expanded by elements corresponding to the input string.

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

The individual elements of the parameter value cannot be null (Nothing in Visual Basic).

Return Value

Returns null if successful; otherwise, some OpcLabs.BaseLib.IStringParsingError indicating the reason of the failure.

This method can return 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.

Remarks

This method is pure, i.e. it does not have observable side effects.

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