OPCDA.NET Reference Manual
GetProperties Method
See Also Send Feedback

OpcDaNetUA.Net4 Assembly > OPCDA.NET Namespace > BGServer Class : GetProperties Method

Visual Basic (Declaration)
C#

items: An array of fuly qualified item ID names.

returnValues: If TRUE, the item property information includes the current property values.

propertyIDs: An array of property ID values identifies the properties to be returned. Nothing (null) indicates that all item properties are to be returned.

tag: This object is passed to the competion handler and allows the user to pass any information that may be needed in the completion handler. null (nothing) can be specified if the application does not require to pass any information.

onCompleted: Competion notification handler. void xxx( BGException ex, ItemProperties[] props, object tag ){}

Available in the OPCDA.NET Professional Edition only.
For the specified set of items the requested properties are read from the server. The result is returned to the user as an argument of the completion handler. For OPC DA V3 servers the OPC DA3 GetProperties() method is used. For OPC DA V2 servers the call is emulated by calling the available OPC DA2 properties handling methods.

Syntax

Visual Basic (Declaration)
Public Sub GetProperties( _ ByVal items() As String, _ ByVal returnValues As Boolean, _ ByVal propertyIDs() As Integer, _ ByVal tag As Object, _ ByVal onCompleted As OnBGSrvGetProperties _ )

Visual Basic (Declaration)

Public Sub GetProperties( _
   ByVal items() As String, _
   ByVal returnValues As Boolean, _
   ByVal propertyIDs() As Integer, _
   ByVal tag As Object, _
   ByVal onCompleted As OnBGSrvGetProperties _
)

C#
public void GetProperties( string[] items, bool returnValues, int[] propertyIDs, object tag, OnBGSrvGetProperties onCompleted )

public void GetProperties( 
   string[] items,
   bool returnValues,
   int[] propertyIDs,
   object tag,
   OnBGSrvGetProperties onCompleted
)

Parameters

items: An array of fuly qualified item ID names.
returnValues: If TRUE, the item property information includes the current property values.
propertyIDs: An array of property ID values identifies the properties to be returned. Nothing (null) indicates that all item properties are to be returned.
tag: This object is passed to the competion handler and allows the user to pass any information that may be needed in the completion handler. null (nothing) can be specified if the application does not require to pass any information.
onCompleted: Competion notification handler. void xxx( BGException ex, ItemProperties[] props, object tag ){}

Requirements

Target Platforms: Windows 7/8/10, Windows Server 2003/2008/2012/2016, .NET 4.x

Syntax

Parameters

Requirements

See Also

Reference