uaPLUS Reference
GetAggregates Method
See Also  Send Feedback
I_HDAPlugin Namespace > IAppPlugin Interface : GetAggregates Method

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.

Glossary Item Box

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 (Declaration) 
Function GetAggregates( _
   ByRef count As Integer, _
   ByRef aggrID As Integer(), _
   ByRef aggrName As String(), _
   ByRef aggrDesc As String() _
) As Integer
C# 
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 XP Professional, Windows Server 2003 family, Windows Vista, Windows 7, Windows Server 2008 family

See Also

© 2010-2018 Copyright Advosol Inc. All Rights Reserved.