RtkSetEvent

RtkSetEvent sets the state of the specified event object to signaled.

Syntax

BOOL RtkSetEvent(
    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 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

Header	Rtkapi.h
Library	rtx_rtk.lib