OPC Studio User's Guide and Reference
Add Method (BrowsePath)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Navigation Namespace > BrowsePath Class : Add Method
The browse path.

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

The browse name to be appended to the browse path.

The value of this parameter cannot be null (Nothing in Visual Basic).

Create a new browse path by appending a browse name to the end of the given browse path.
Syntax
'Declaration
 
<NotNullAttribute()>
Public Shared Function Add( _
   ByVal browsePath As BrowsePath, _
   ByVal name As String _
) As BrowsePath
'Usage
 
Dim browsePath As BrowsePath
Dim name As String
Dim value As BrowsePath
 
value = BrowsePath.Add(browsePath, name)
[NotNull()]
public static BrowsePath Add( 
   BrowsePath browsePath,
   string name
)
[NotNull()]
public:
static BrowsePath^ Add( 
   BrowsePath^ browsePath,
   String^ name
) 

Parameters

browsePath
The browse path.

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

name
The browse name to be appended to the browse path.

The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

Returns the appended browse path.

This method never returns null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

One of the arguments provided to a method is not valid.

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.

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.

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