RtkPulseEvent

RtkPulseEvent provides a single operation that sets (to signaled) the state of the specified event object and then resets it (to non-signaled) after releasing the appropriate number of waiting threads.

Syntax

BOOL RtkPulseEvent(
    RTSSINST RtssInst,
    PULONG pErrorCode,
    HANDLE hEvent
);

Parameters

RtssInst

An RTSSINST value returned from a call to RtkRtssAttach.

pErrorCode

A pointer to a location where additional error information may be returned. This location need not be defined; the user may pass a NULL value. If defined, this location is set to NULL if no error occurred.

hEvent

The handle which identifies the event object as returned by a preceding call to RtkCreateEvent or RtkOpenEvent.

Return Values

TRUE if the function succeeds, FALSE if the function fails

Remarks

For a manual-reset event object, all waiting threads that can be released are released. The function then resets the event object's state to non-signaled and returns.

For an auto-reset event object, the function resets the state to non-signaled and returns after releasing a single waiting thread, even if multiple threads are waiting.

If no threads are waiting, or if no thread can be released immediately, RtkPulseEvent simply sets the event object's state to non-signaled and returns.

Requirements

Header	Rtkapi.h
Library	rtx_rtk.lib