BrowseProperties Method (IEasyDAClient)

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

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ElementsNotNullAttribute()>
<NotNullAttribute()>
Function BrowseProperties( _
   ByVal serverDescriptor As ServerDescriptor, _
   ByVal nodeDescriptor As DANodeDescriptor _
) As DAPropertyElementCollection

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

[ElementsNotNull()]
[NotNull()]
DAPropertyElementCollection BrowseProperties( 
   ServerDescriptor serverDescriptor,
   DANodeDescriptor nodeDescriptor
)

[ElementsNotNull()]
[NotNull()]
DAPropertyElementCollection^ BrowseProperties( 
   ServerDescriptor^ serverDescriptor,
   DANodeDescriptor^ nodeDescriptor
)

Parameters

serverDescriptor: The OPC server involved in the operation.
nodeDescriptor: Descriptor of the node for which the properties will be browsed.

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.

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.

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

IEasyDAClient Interface
IEasyDAClient Members

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.