OPC Historian .NET Server Toolkit Reference
GetHistorianStatus Method (IAppPlugin)

OUT: The current status of the historian.
OUT: The current time at the historian location.
OUT: The time when the historian was last started.
OUT: The major version identification of the historian.
OUT: The minor version identification of the historian.
OUT: The build number identification of the historian.
OUT: The maximum number of values that can be returned by the server on a per item basis. A value of 0 indicates that the server forces no limit on the number of values it can return.
OUT: A string explaining historian status when the status value is OPCHDA_INDETERMINATE.
OUT: A vendor specific informational string.
This method returns the information on the current status of the server.
Syntax
'Usage
 
Dim instance As IAppPlugin
Dim status As OPCHDAServerStatus
Dim currentTime As Date
Dim startTime As Date
Dim majorVersion As Short
Dim minorVersion As Short
Dim buildNumber As Short
Dim maxReturnValues As Integer
Dim statusString As String
Dim vendorInfo As String
Dim value As Integer
 
value = instance.GetHistorianStatus(status, currentTime, startTime, majorVersion, minorVersion, buildNumber, maxReturnValues, statusString, vendorInfo)
int GetHistorianStatus( 
   out OPCHDAServerStatus status,
   out DateTime currentTime,
   out DateTime startTime,
   out short majorVersion,
   out short minorVersion,
   out short buildNumber,
   out int maxReturnValues,
   out string statusString,
   out string vendorInfo
)

Parameters

status
OUT: The current status of the historian.
currentTime
OUT: The current time at the historian location.
startTime
OUT: The time when the historian was last started.
majorVersion
OUT: The major version identification of the historian.
minorVersion
OUT: The minor version identification of the historian.
buildNumber
OUT: The build number identification of the historian.
maxReturnValues
OUT: The maximum number of values that can be returned by the server on a per item basis. A value of 0 indicates that the server forces no limit on the number of values it can return.
statusString
OUT: A string explaining historian status when the status value is OPCHDA_INDETERMINATE.
vendorInfo
OUT: A vendor specific informational string.

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

See Also

Reference

IAppPlugin Interface
IAppPlugin Members

 

 


Copyright © 2004-2019 Advosol Inc. All rights reserved

Send Feedback