Windows Driver IPC API (RTKAPI) Reference

The RTKAPI functions access RTX IPC mechanisms from Windows kernel device drivers.

RTKAPI Function	Description
RtkCloseHandle	Closes an open object handle.
RtkCreateEvent	Creates an RTSS event. A handle is returned to the newly created event.
RtkCreateMutex	Creates an RTSS mutex. A handle is returned to the newly created mutex object.
RtkCreateSemaphore	Creates a named semaphore object.
RtkCreateSharedMemory	Creates a named region of physical memory that can be mapped by any process.
RtkGetLicenses	Retrieves information about all licenses installed on the system.
RtkIsAppRunnable	Allows RTSS applications to validate an application's RTSS signature.
RtkIsRuntimeLicensed	Verifies whether a specified RTX Runtime version is installed and has a valid license.
RtkIsTcpStackLicensed	Verifies whether a specified RTX RT/TCP-IP Stack version is installed and has a valid license.
RtkOpenEvent	Returns a handle to the named RTSS event.
RtkOpenMutex	Returns a handle to the named RTSS mutex.
RtkOpenSemaphore	Returns a handle of an existing named semaphore object.
RtkOpenSharedMemory	Opens a named physical-mapping object.
RtkPulseEvent	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.
RtkReleaseMutex	Relinquishes ownership of an RTSS mutex.
RtkReleaseSemaphore	Increases the count of the specified semaphore object by a specified amount.
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.
RtkRtssAttach	Attaches a kernel device driver to RTSS.
RtkRtssAttachEx	Attaches a kernel device driver to RTSS.
RtkRtssDetach	Detaches a kernel device driver from RTSS.
RtkSetEvent	Sets the state of the specified event object to signaled.
RtkWaitForSingleObject	Returns when one of the following occurs: The specified object is in the signaled state. The time-out interval elapses.
RtkWaitForMultipleObjects	Allows a thread to wait on one of multiple objects to be signaled.