Rockwell Automation 2711P Software Development Kit User Manual - Manual (Page 79)

Publication 2711P-UM005A-EN-P - March 2007
PanelView Plus CE-Specific Extensions to the WinCE API 79
Return Values:
Remarks:
This first time GetNextEvent() is called, the parameter nIndex is
typically the index to the Event that was returned by calling
GetFirstEvent() or GetLastEvent(). Subsequent calls should provide the
index that was returned in the preceding call to GetNextEvent().
If the return code is EVENT_SUCCESS, the next Event in the specified
direction was returned to the Event structure at pEvent.
EVENT_EOF is returned when the Event Log has determined that it is
at the end of the file. An empty record is interpreted as the end of file.
Is it recommended that GetFirstEvent()or GetLastEvent() always be
called before entering an iteration loop using GetNextEvent();
otherwise, the starting index will be misplaced. Another consideration
is that an empty Event Log returns EVENT_EOF; whereas,
GetFirstEvent() or GetLastEvent() will properly return EVENT_
FILE_EMPTY when the file is empty.
Portability:
This function is specific to the PanelView Plus CE.
Requirements:
GetNextEvent - Return Codes
Value Description
EVENT_SUCCESS The Event was read successfully and returned to the
structure at pEvent.
EVENT_EOF No Event was returned The record index is at the end of
the file or at an empty Event.
EVENT_FAIL No Event was returned. The operation failed.
Runs On Version Defined In Link To
PanelView Plus CE All EventLog.h EventLog.lib