The GetHistoricFaultSituation Method returns a LogEntries array with valid EventGoing field. Method invocation shall be possible for all users (read-only).
Signature
GetHistoricFaultSituation (
[in] 0:Byte FaultSituationNumber,
[out] LogEntryDataType[] HistoricLogEntries
);
|
Argument |
Description |
|
FaultSituationNumber |
Fault situation number the faults belong to. 0 identifies the current situation, 1 the historic situation preceding the current situation, and so on (see explanation below). |
|
HistoricLogEntries |
Array containing the log entries with valid EventGoing field entry. An empty array is returned if no logbook entry matches the filter criteria. |
The Method Result Codes (defined in Call Service) are defined in Table 26.
Table 26 – Possible Method Result Codes
|
Result Code |
Description |
|
Good |
The Method execution was successful. |
|
Bad_InvalidArgument |
The fault situation specified by FaultSituationNumber does not exist. |
|
Bad_Locked |
The parent EncoderChannelType Object is locked by a different Client’s Session. |
|
Bad_RequiresLock |
The parent EncoderChannelType Object is not locked. Clients must lock the parent EncoderChannelType Object before invoking a Method. |
|
Bad_UnexpectedError |
The Server is not able to execute the function because an unexpected error occurred. The Device might be temporarily unavailable or unreachable due to network failure. |