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 an NTXSTATUS and, on success, the lpEventInfo buffer is filled in with information about the event notification. For a description of possible event types, see the NTXEVENTINFO structure.

NTXSTATUS ntxNotifyEvent(
    DWORD dwEventFlags,
    DWORD dwMilliseconds,
    NTXEVENTINFO lpEventInfo
);

Parameters

dwEventFlags

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

NTX_SPONSOR_NOTIFICATIONS

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

NTX_DEPENDENT_NOTIFICATIONS

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

NTX_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.

dwMilliseconds

Specifies the length of time the thread will block waiting for the notification to occur.

lpEventInfo

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

Return Values

E_OK

Success.

Error code

Failure. To determine the status, call ntxGetLastRtError.

Status

E_OK 0x0000

No exceptional conditions occurred.

E_TIME

The specified dwMilliseconds elapsed before any event was received.

E_NTX_INTERNAL_ERROR

The DLL could not contact the RT kernel to complete the request.

Requirements