It_GetEvent 

Use

Gets an event, by filling out the information from the R/3 application server into the GUI Library's event structure and all of the related structures.

A call to It_GetEvent is a blocking call, meaning that it waits for a server response.

Syntax

DWORD DLEX It_GetEvent(HANDLE hMr, PPIT_EVENT ppEvt);

Parameters

hMr

Connection handle

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.

Return Value

Returns TRUE on success, FALSE on error.

Comments

It_GetEvent calls It_GetEventEx with standard flags (flgs set to zero).

It_GetEvent can read each event once. After getting the event information with It_GetEvent, the same event is no longer available for you to read again, meaning that a subsequent call to It_GetEvent will wait for the next event. If you wish to read the information of an even more than once, use It_PeekEvent, instead.

After getting an event, you can read the bits in the eventtype member of IT_EVENT to get a preview of the type of information that exists in the event structure.

See Also

It_GetEventEx, It_PeekEvent