|
Starts the alarm history display.
syntax
SubscribeHistorical(
filter,
searchRecordCnt,
startTime,
endTime
[,includeStartTime = T]
[,includeEndTime = T]
[,showRecordCnt = 0]
[,includeSameTimeLastRecords = F]
)
Parameters
filter
|
|
Type:
|
character
|
|
Filter. See explanation in SubscribeSummary.
Please note that when using HISTORICAL2 or HISTORICAL3, you cannot use [ACK], [RECOVER], [TYPE], [TYPEJP], or [STATE] in the filter.
|
searchRecordCnt
|
|
Type:
|
Number
|
|
Number of records to search. When set to 0, search all records.
|
startTime
|
|
Type:
|
time
|
|
The start time.
|
endTime
|
|
Type:
|
time
|
|
End time.
|
includeStartTime
|
|
Type:
|
Boolean
|
|
Include start time?
|
includeEndTIme
|
|
Type:
|
Boolean
|
|
Include end time?
|
showRecordCnt
|
|
Type:
|
Number
|
|
Number of records to display. When set to 0, it is the same as the number of records to search.
|
includeSameTimeLastRecords
|
|
Type:
|
Boolean
|
|
If TRUE, even if the search count condition (serchRecordCnt/showRecordCnt) is reached, if an alarm history with the same time exists since the last alarm history, that record will also be included.
|
Return Value
|
|
Type:
|
Boolean
|
|
FALSE - Failure. TRUE - Success.
|
 Explanation
Starts the alarm history display. Only the number of records displayed will be displayed.
If a filter is specified, the search will continue until the number of records to be displayed is reached. This can cause long delays in displaying records when there are a large number of alarms and it is difficult to find the number of records to display.
To avoid this, if the number of search records exceeds the limit, the search will stop and the records found up to that point will be displayed.
|
reference
SubscribeSummary
SubscribeHistorical
SubscribeRealtime
CancelSubscribe
Ack
AckSelected
AckPage
AckAll
IsCanAck
FireAlarm
FireAlarm (Root)
GetAlarmScriptResult
GetAlarmLayout
Connect
DisConnect
GetLastError
|