BrowseProperties Method (EasyDAClientCore)

Browse for available item properties of a specified OPC item. Specify server descriptor, and node descriptor.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function BrowseProperties( _
   ByVal serverDescriptor As ServerDescriptor, _
   ByVal nodeDescriptor As DANodeDescriptor _
) As DAPropertyElementCollection

'Usage
 
Dim instance As EasyDAClientCore
Dim serverDescriptor As ServerDescriptor
Dim nodeDescriptor As DANodeDescriptor
Dim value As DAPropertyElementCollection
 
value = instance.BrowseProperties(serverDescriptor, nodeDescriptor)

public DAPropertyElementCollection BrowseProperties( 
   ServerDescriptor serverDescriptor,
   DANodeDescriptor nodeDescriptor
)

public:
DAPropertyElementCollection^ BrowseProperties( 
   ServerDescriptor^ serverDescriptor,
   DANodeDescriptor^ nodeDescriptor
)

Parameters

serverDescriptor

The OPC server involved in the operation.

Because the OpcLabs.EasyOpc.ServerDescriptor has an implicit conversion from System.Guid, System.String and OpcLabs.EasyOpc.ServerElement, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a GUID (representing the CLSID of the server), a string (representing the so-called OPC server descriptor string, such as a ProgID or the URL of the server), or a OpcLabs.EasyOpc.ServerElement object (result from OPC browsing), in place of this parameter, and the corresponding OPC server descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.ServerDescriptor.FromGuid, OpcLabs.EasyOpc.ServerDescriptor.FromString or OpcLabs.EasyOpc.ServerDescriptor.FromServerElement static method instead.

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

nodeDescriptor

Descriptor of the node for which the properties will be browsed.

Because the DANodeDescriptor has an implicit conversion from System.String and OpcLabs.EasyOpc.DataAccess.AddressSpace.DANodeElement, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the qualified name of the node), or a OpcLabs.EasyOpc.DataAccess.AddressSpace.DANodeElement object (result from OPC browsing), in place of this parameter, and the corresponding OPC DA node descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the DANodeDescriptor.FromString or DANodeDescriptor.FromDANodeElement static method instead.

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

Return Value

The method returns a keyed collection of OpcLabs.EasyOpc.DataAccess.AddressSpace.DAPropertyElement values, each containing information about a particular property found. The keys of the keyed collection are the IDs of the properties.

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

The individual elements of the returned value are never 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.
OpcLabs.EasyOpc.OperationModel.OpcException	The OPC "Classic" (or OPC XML-DA) operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

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.

OpcLabs.EasyOpc.OperationModel.OpcException

The OPC "Classic" (or OPC XML-DA) operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

Using implicit conversions, you can pass an item ID in place of node descriptor.

The server(s) can be local or can be remotely accessed via DCOM.

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

EasyDAClientCore Class
EasyDAClientCore Members

Documentation Home, Send Documentation Feedback. Technical Support