OPC Studio User's Guide and Reference
IsPrefix Method (UABrowsePathElementCollection)



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Navigation Namespace > UABrowsePathElementCollection Class : IsPrefix Method
A UABrowsePathElementCollection object. The browse path element collection to be tested as a prefix.

Because the UABrowsePathElementCollection has an implicit conversion from OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedNameCollection, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedNameCollection (containing a sequence of qualified names, assumed to form a relative browse path using "any hierarchical" forward references) in place of this parameter, and the corresponding OPC UA browse path element collection will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromUAQualifiedNameCollection static method instead.

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

The individual elements of the parameter value cannot be null (Nothing in Visual Basic).

Determines whether a given OPC-UA browse path element collection is a prefix of the current browse path element collection.
Syntax
'Declaration
 
<PureAttribute()>
Public Function IsPrefix( _
   ByVal prefix As UABrowsePathElementCollection _
) As Boolean
'Usage
 
Dim instance As UABrowsePathElementCollection
Dim prefix As UABrowsePathElementCollection
Dim value As Boolean
 
value = instance.IsPrefix(prefix)
[Pure()]
public bool IsPrefix( 
   UABrowsePathElementCollection prefix
)
[Pure()]
public:
bool IsPrefix( 
   UABrowsePathElementCollection^ prefix
) 

Parameters

prefix
A UABrowsePathElementCollection object. The browse path element collection to be tested as a prefix.

Because the UABrowsePathElementCollection has an implicit conversion from OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedNameCollection, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedNameCollection (containing a sequence of qualified names, assumed to form a relative browse path using "any hierarchical" forward references) in place of this parameter, and the corresponding OPC UA browse path element collection will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromUAQualifiedNameCollection static method instead.

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

The individual elements of the parameter value cannot be null (Nothing in Visual Basic).

Return Value

True if the given browse path element collection is a prefix of the current browse path element collection; false otherwise.
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.

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