TryRelativeTo Method (BrowsePath)

Attempts to compute a relative path string that leads from the current browse to a given browse path.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function TryRelativeTo( _
   ByVal toPath As BrowsePath, _
   ByVal maximumParentDepth As Integer, _
   ByRef relativeResult As String _
) As Boolean

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

public bool TryRelativeTo( 
   BrowsePath toPath,
   int maximumParentDepth,
   out string relativeResult
)

public:
bool TryRelativeTo( 
   BrowsePath^ toPath,
   int maximumParentDepth,
   [Out] String^ relativeResult
)

Parameters

toPath: The browse path to which the relative path string should be computed.
maximumParentDepth: How many levels above the base path can be referenced.
relativeResult: The relative path string from the current browse path to the toPath.

Return Value

true if the relative path has been computed; false otherwise.

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.

Example

If current browse path is /ElementA/ElementB, and is /ElementA/ElementB/ElementC/ElementD, the 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

Reference

BrowsePath Class
BrowsePath Members

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