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

transactionID
An identifier created by the client and passed to the server in this call. The server shall return this identifier along with the results of this call.
startTime
The beginning of the history period to be read.
interval
Update interval to send new data
serverHandles
The list of server item handles for the items to be read.
cancelID
Place to return a Server generated ID to be used in case the operation needs to be canceled.
errors
Array of HRESULTs indicating whether the corresponding server handle was valid.

Glossary Item Box

This method reads the values, qualities, and timestamps from the history database from the specified start time at the update interval for one or more items. This method is intended to be used to update the client software with new data as it becomes available; e.g., update a trend with new data on a periodic basis. The results are returned via the client's IOPCHDA_DataCallback::OnDataChange method.

Syntax

Visual Basic (Declaration) 
Function AdviseRaw( _
   ByVal transactionID As Integer, _
   ByVal startTime As Date, _
   ByVal interval As TimeSpan, _
   ByVal serverHandles() As Integer, _
   ByRef cancelID As Integer, _
   ByRef errors As Integer() _
) As Integer
C# 
int AdviseRaw( 
   int transactionID,
   DateTime startTime,
   TimeSpan interval,
   int[] serverHandles,
   out int cancelID,
   out int[] errors
)

Parameters

transactionID
An identifier created by the client and passed to the server in this call. The server shall return this identifier along with the results of this call.
startTime
The beginning of the history period to be read.
interval
Update interval to send new data
serverHandles
The list of server item handles for the items to be read.
cancelID
Place to return a Server generated ID to be used in case the operation needs to be canceled.
errors
Array of HRESULTs indicating whether the corresponding server handle was valid.

Return Value

HRESULTS success/error code.

Remarks

The requests are stored and handled by the advise handling thread until the request is cancelled. The sample implementation has one such thread. To improve performance it may be necessary in some servers to have multiple advise handling threads.

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.