RtkResetEvent

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

Syntax

Copy
NTSTATUS RtkResetEvent(
    [in]    RTSSINST RtssInst,
    [in]    HANDLE EventHandle,
);

Parameters

[in] RtssInst

An RTSSINST value returned from a call to RtkRtssAttach or RtkRtssAttachEx. Pass a valid RTSSINST value or the call will fail with STATUS_INVALID_PARAMETER.

[in] EventHandle

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

Return Value

If the function succeeds, it returns STATUS_SUCCESS. If the function fails, it returns one of the following NTSTATUS error codes:

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

Minimum supported version Header Library

IRQL

wRTOS 1.0 SDK

RtkApi.h

RtkApi_W64.lib

PASSIVE_LEVEL

See Also: