RtkSetEvent
RtkSetEvent sets the state of the specified event object to signaled.
Syntax
NTSTATUS RtkSetEvent( 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
RtkSetEvent 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 a manual-reset event object remains signaled until it is set explicitly to the non-signaled state by the RtkSetEvent function. Any number of waiting threads, or threads that subsequently begin wait operations for the specified event object by calling the wait functions, can be released while the object's state is signaled.
The state of an auto-reset event object, the function resets the state to non-signaled and returns after releasing remains signaled until a single waiting thread is released, at which time the system automatically sets the state to non-signaled. If no threads are waiting, the event object's state remains signaled.
Requirements
Minimum Supported Version | RTX64 2013 with Service Pack 1 |
Header | RtkApi.h |
Library | RtkApi.lib |
IRQL | PASSIVE_LEVEL |
See Also: