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

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

[NotNull()]
[Pure()]
public string RelativeTo( 
   BrowsePath toPath
)

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

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

Return Value

No levels above the base path can be referenced. If you want to allow this, use an overload with maximumParentDepth argument.

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

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows