RelativeTo(BrowsePath,Int32) Method

Computes a relative path string that leads from the current browse to a given browse path, with specified maximum parent depth.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
<PureAttribute()>
Public Overloads Function RelativeTo( _
   ByVal toPath As BrowsePath, _
   ByVal maximumParentDepth As Integer _
) As String

'Usage
 
Dim instance As BrowsePath
Dim toPath As BrowsePath
Dim maximumParentDepth As Integer
Dim value As String
 
value = instance.RelativeTo(toPath, maximumParentDepth)

[NotNull()]
[Pure()]
public string RelativeTo( 
   BrowsePath toPath,
   int maximumParentDepth
)

[NotNull()]
[Pure()]
public:
String^ RelativeTo( 
   BrowsePath^ toPath,
   int maximumParentDepth
)

Parameters

toPath

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

Because the 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).

Return Value

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

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

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	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.
System.ArgumentOutOfRangeException	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.

System.ArgumentNullException

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.

System.ArgumentOutOfRangeException

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 method is pure, i.e. it does not have observable side effects.

Example

If current browse path is /ElementA/ElementB, and is /ElementA/ElementB/ElementC/ElementD, the result will be "ElementC/ElementD".

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

BrowsePath Class
BrowsePath Members
Overload List

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

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.