TryAppendRelative(String,Int32) Method

Attempts to append a relative browse path string to the current browse path, with specified maximum parent depth.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<CanBeNullAttribute()>
Public Overloads Function TryAppendRelative( _
   ByVal more As String, _
   ByVal maximumParentDepth As Integer _
) As IStringParsingError

'Usage
 
Dim instance As BrowsePath
Dim more As String
Dim maximumParentDepth As Integer
Dim value As IStringParsingError
 
value = instance.TryAppendRelative(more, maximumParentDepth)

[CanBeNull()]
public IStringParsingError TryAppendRelative( 
   string more,
   int maximumParentDepth
)

[CanBeNull()]
public:
IStringParsingError^ TryAppendRelative( 
   String^ more,
   int maximumParentDepth
)

Parameters

more: The relative browse path string to be appended to the current browse path.
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

Returns null if successful; otherwise, some OpcLabs.BaseLib.IStringParsingError indicating the reason of the failure.

This method can return 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.

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.