Windows Driver IPC API (RTKAPI) Reference

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

RTKAPI Function Description

RtkCloseHandle

Closes an open object handle.

RtkCreateEvent

Creates an RTSS event object. A handle is returned to the newly created event.

RtkCreateMutex

Creates an RTSS mutex object. A handle is returned to the newly created mutex object.

RtkCreateSemaphore

Creates an RTSS semaphore object.

RtkCreateSharedMemory

Creates a region of physical memory that can be mapped by a RTSS or RTX64-enabled Windows process, or other RTK enabled Windows drivers.

RtkGetLicenses

Retrieves information about all licenses installed on the system.

RtkGetProxyThreadPriority Gets the priority value of the proxy thread associated with the driver-created kernel thread.
RtkGetRuntimeVersionEx Retrieves the Runtime version of the installed RTX64 product.
RtkIsAppRunnable Allows RTSS applications to validate an application's RTSS signature.
RtkIsRuntimeLicensed Verifies whether a specified RTX64 Runtime version is installed and has a valid license.
RtkIsRuntimeLicensedEx Verifies whether a specified RTX64 Runtime version is installed and has a valid license.
RtkIsTcpStackLicensed Verifies whether a specified RTX64 RT/TCP-IP Stack version is installed and has a valid license.
RtkIsRuntimeLicensedEx Verifies whether a specified RTX64 RT/TCP-IP Stack version is installed and has a valid license.

RtkOpenEvent

Returns a handle to the named RTSS event object.

RtkOpenMutex

Returns a handle to the named RTSS mutex object.

RtkOpenSemaphore

Returns a handle to the named RTSS semaphore object.

RtkOpenSharedMemory

Opens a physical-mapping memory 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 object.

RtkReleaseSemaphore

Increases the count of the specified semaphore object by a specified amount.

RtkResetEvent

Sets the specified event object to the nonsignaled state.

RtkRtssAttach

Attaches a Windows kernel device driver to RTSS.

RtkRtssAttachEx

Attaches a Windows kernel device driver to RTSS.

RtkRtssDetach

Detaches a Windows kernel device driver from RTSS.

RtkSetEvent

Sets the state of the specified event object to signaled.

RtkSetProxyThreadPriority Sets the priority value of the proxy thread associated with the driver-created kernel thread.

RtkWaitForMultipleObjects

Allows a thread to wait on one of multiple objects to be signaled.

RtkWaitForSingleObject

Allows a thread to wait on an object to be signaled.

 

See Also