Blocks until one of the desired notifications has been received. Use function to get notifications about any combination of these events: system, sponsor, or dependent events.

The call returns Boolean status and, on success, the lpEventInfo buffer is filled with information about the event notification. For a description of possible event types, see the EVENTINFO structure.

BOOLEAN RtNotifyEvent(
    DWORD dwEventFlags,
    DWORD dwMilliseconds,
    LPEVENTINFO lpEventInfo
);

Parameters

dwEventFlags

Specifies a combination of the following notification types which the function will receive:

RT_SPONSOR_NOTIFICATIONS

Receives all notifications that a sponsor might receive about its dependents
DEPENDENT_REGISTERED, DEPENDENT_UNREGISTERED, DEPENDENT_TERMINATED

RT_DEPENDENT_NOTIFICATIONS

Receives all notifications that a dependent might receive about its sponsor - include: SPONSOR_UNREGISTERED, SPONSOR_TERMINATED

RT_EXIT_NOTIFICATIONS

Receives the TERMINATE and RTIO_CONSOLE_CLOSED notifications

RT_SYSTEM_NOTIFICATIONS

Receives system level notifications:
RT_CLIENT_DOWN, RT_CLIENT_UP, RT_CLIENT_UP, RT_CLIENT_DOWN, NT_BLUESCREEN, NT_HOST_SHUTDOWN_PENDING, KERNEL_STOPPING, NT_HOST_HIBERNATE, NT_HOST_STANDBY, KERNEL_STOP_PENDING and KERNEL_STOPPING

The values may be OR-ed to give various combinations.
The special value RT_ALL_NOTIFICATIONS is an OR of all of the above values.

dwMilliseconds

Specifies the length of time the thread will block waiting for the notification to occur. The kernel converts miulliseconds to high-level ticks.

lpEventInfo

Pointer to the data buffer into which the event information will be placed.

Return Values

TRUE and fills in the lpEventInfo buffer.

Success.

FALSE

Failure. To determine the status, call GetLastRtError.

Status

E_OK 0x0000

No exceptional conditions occurred.

E_TIME

The number of milliseconds defined in dwMilliseconds elapsed before a message was received.

Requirements