OPC Studio User's Guide and Reference
EscapeBrowseName Method



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Navigation Namespace > BrowsePath Class : EscapeBrowseName Method
Browse name to be escaped.

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

Escapes a browse name so that it can be placed into a string form of the browse path.
Syntax
'Declaration
 
<NotNullAttribute()>
<PureAttribute()>
Public Shared Function EscapeBrowseName( _
   ByVal browseName As String _
) As String
'Usage
 
Dim browseName As String
Dim value As String
 
value = BrowsePath.EscapeBrowseName(browseName)
[NotNull()]
[Pure()]
public static string EscapeBrowseName( 
   string browseName
)
[NotNull()]
[Pure()]
public:
static String^ EscapeBrowseName( 
   String^ browseName
) 

Parameters

browseName
Browse name to be escaped.

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

Return Value

The escaped browse name.

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.

Remarks

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

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