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
NTSTATUS RtkResetEvent( RTSSINST RtssInst, HANDLE EventHandle, );
Parameters
RtssInst
An RTSSINST value returned from a call to RtkRtssAttach or RtkRtssAttachEx. Must pass in a valid RTSSINST value or the call will fail with STATUS_INVALID_PARAMETER.
EventHandle
The handle which identifies the event object as returned by a preceding call to RtkCreateEvent or RtkOpenEvent.
Return Value
RtkResetEvent returns STATUS_SUCCESS on success or on failure one of the following NTSTATUS error codes is possible:
- STATUS_INVALID_PARAMETER
- STATUS_UNSUCCESSFUL
- STATUS_INVALID_HANDLE
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
Minimum Supported Version | RTX64 2013 with Service Pack 1 |
Header | RtkApi.h |
Library | RtkApi.lib |
IRQL | PASSIVE_LEVEL |
See Also: