OPC Studio User's Guide and Reference
TryAppendRelative(String,Int32) Method



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Navigation Namespace > BrowsePath Class > TryAppendRelative Method : TryAppendRelative(String,Int32) Method
The relative browse path string to be appended to the current browse path.
How many levels above the base path can be referenced.
Attempts to append a relative browse path string to the current browse path, with specified maximum parent depth.
Syntax
'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.
maximumParentDepth
How many levels above the base path can be referenced.

Return Value

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

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.

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

See Also