'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)
bool TryRelativeTo( object toPath, int maximumParentDepth, out string relativeResult )
bool TryRelativeTo( Object^ toPath, int maximumParentDepth, [Out] String^ 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
to2147483647 (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.