OPC Studio User's Guide and Reference
TryRelativeTo Method (_BrowsePath)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Navigation.ComTypes Namespace > _BrowsePath Interface : TryRelativeTo Method
The browse path to which the relative path string should be computed.

Because the OpcLabs.BaseLib.Navigation.BrowsePath has an implicit conversion from System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (containing an absolute browse path to be parsed) in place of this parameter, and the corresponding browse path object will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromString static method instead. CAUTION: Parsing the browse path can throw OpcLabs.BaseLib.Navigation.Parsing.BrowsePathFormatException.

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

How many levels above the base path can be referenced.

Valid values of this parameter are in the range from 0 to 2147483647 (Int32.MaxValue).

The relative path string from the current browse path to the toPath.

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

Attempts to compute a relative path string that leads from the current browse to a given browse path.
Syntax
'Declaration
 
Function TryRelativeTo( _
   ByVal toPath As Object, _
   ByVal maximumParentDepth As Integer, _
   ByRef relativeResult As String _
) As Boolean
'Usage
 
Dim instance As _BrowsePath
Dim toPath As Object
Dim maximumParentDepth As Integer
Dim relativeResult As String
Dim value As Boolean
 
value = instance.TryRelativeTo(toPath, maximumParentDepth, relativeResult)

Parameters

toPath
The browse path to which the relative path string should be computed.

Because the OpcLabs.BaseLib.Navigation.BrowsePath has an implicit conversion from System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (containing an absolute browse path to be parsed) in place of this parameter, and the corresponding browse path object will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromString static method instead. CAUTION: Parsing the browse path can throw OpcLabs.BaseLib.Navigation.Parsing.BrowsePathFormatException.

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

maximumParentDepth
How many levels above the base path can be referenced.

Valid values of this parameter are in the range from 0 to 2147483647 (Int32.MaxValue).

relativeResult
The relative path string from the current browse path to the toPath.

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

Return Value

true if the relative path has been computed; false otherwise.
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 value of an argument is outside the allowable range of values as defined by the invoked method.

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 member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

Example
If current browse path is /ElementA/ElementB, and toPath is /ElementA/ElementB/ElementC/ElementD, the relativeResult will be "ElementC/ElementD" and the method will return true.
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