Like theIt_GetEvent and the It_GetEventEX functions, It_PeekEvent gets the information of an event into the event structure.
However, unlike It_GetEvent*, It_PeekEvent allows you to read the same event multiple times. (When using It_GetEvent, you can get a specific event only once. Any subsequent It_GetEvent call waits for the next event to occur. In contrast, using It_PeekEvent multiple times reads the same event).
You can use It_PeekEvent after sending an event (with It_SendEvent*) to look at the R/3 response. You can look at this response event multiple times before getting that event with an It_GetEvent* call.
Note, however, that if you first use It_GetEvent* to get the event, using It_PeekEvent cannot get that event anymore. It will be blocking for the next event to occur.
DWORD DLEX It_PeekEvent(HANDLE hMr, PPIT_EVENT ppEvt);
Pointer to a pointer to the IT_EVENT structure. The client defines a PIT_EVENT and initializes it to zero. On return, this value will be changed to point to a properly structured IT_EVENT structure.
Returns TRUE on success, FALSE on error.
See AlsoIt_GetEvent, It_GetEventEx, It_PeekTitle.