RtkResetEvent

RtkResetEvent 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 RtkResetEvent(
    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

The state of an event object remains non-signaled until it is explicitly set to signaled by the RtkSetEvent or RtkPulseEvent function. The non-signaled state blocks the execution of any threads that have specified the event object in a call to a wait function.

The RtkResetEvent function is used primarily for manual-reset event objects, which must be set explicitly to the non-signaled state. Auto-reset event objects automatically change from signaled to non-signaled after a single waiting thread is released.

Requirements

Header	Rtkapi.h
Library	rtx_rtk.lib