GetAggregates Method (AppPlugin)

This method returns the list of aggregates supported by the server. The OPC defined aggregates are defined in Definitions.Aggregates array. Vendor specific aggregates also are supported. The vendor supplied aggregates are made available to allow the client to use all the methods available to their specific server. If no aggregates are supported, the method shall return a count of 0 and NULL pointers.

Syntax

Visual Basic
C#

'Usage
 
Dim instance As AppPlugin
Dim count As Integer
Dim aggrID As Integer()
Dim aggrName As String()
Dim aggrDesc As String()
Dim value As Integer
 
value = instance.GetAggregates(count, aggrID, aggrName, aggrDesc)

public int GetAggregates( 
   out int count,
   out int[] aggrID,
   out string[] aggrName,
   out string[] aggrDesc
)

Parameters

count: OUT: The number of aggregate descriptions returned.
aggrID: OUT: The aggregate identification index number.
aggrName: OUT: The name of the aggregate.
aggrDesc: OUT: A description of the aggregate.

Return Value

HRESULTS success/error code.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

AppPlugin Class
AppPlugin Members