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

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.

Glossary Item Box

This method returns the information on the current status of the server.

Syntax

Visual Basic (Declaration) 
Function GetHistorianStatus( _
   ByRef status As OPCHDAServerStatus, _
   ByRef currentTime As Date, _
   ByRef startTime As Date, _
   ByRef majorVersion As Short, _
   ByRef minorVersion As Short, _
   ByRef buildNumber As Short, _
   ByRef maxReturnValues As Integer, _
   ByRef statusString As String, _
   ByRef vendorInfo As String _
) As Integer
C# 
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 XP Professional, Windows Server 2003 family, Windows Vista, Windows 7, Windows Server 2008 family

See Also

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