Matrix of Real-Time (RTAPI) Functions
Note: APIs that are not explicitly documented as supported are not guaranteed to work. You should thoroughly test any code that uses undocumented functions.
|
RTAPI function name |
Notes |
Deterministic? |
|---|---|---|
|
|
Yes - can block if another thread holds the lock. | |
|
|
No |
|
|
|
No |
|
|
|
Yes, but only when one real-time processor configured. |
|
|
The call is supported as both an RT call and as a Windows call (for example, RtAtoi and Atoi). |
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
No | |
|
|
No | |
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
No | |
|
The IPC namespace is separate from the Windows namespace. |
No | |
|
The IPC namespace is separate from the Windows namespace. |
No | |
|
|
No | |
|
The IPC namespace is separate from the Windows namespace. |
No | |
|
|
No | |
|
|
No | |
|
|
No | |
|
|
Yes |
|
|
|
No | |
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
| No | ||
| No | ||
| RtEnumProcessModules |
Yes - the elapsed time for the call is less than 5 microseconds. |
|
| RtEnumProxyProcesses | No | |
| RtExpandMSpace | No | |
|
|
No | |
|
|
Yes, but only if at least one processor is assigned to wRTOS. |
|
| RtGenerateEvent |
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
No | |
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
| RtGetDongles | No | |
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes |
|
| Yes | ||
|
|
No | |
|
|
Yes |
|
|
|
Yes |
|
|
|
No | |
|
The call is supported as both an RT call and as a Windows call (for example, RtAtoi and Atoi). |
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes |
|
| RtGetProcessMSpace | Yes | |
| RtGetProcessorInfo | Yes - the elapsed time for the call is less than 5 microseconds. | |
|
|
Yes |
|
|
RtGetProxyThreadPriority (can only be called by Windows applications linked with wRTOS) |
No | |
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes |
|
|
|
Yes |
|
|
The priority spectrum of wRTOS is 0 to 127, whereas the Windows range is {-15, -2, -1, 0, 1, 2, 15}. The call is supported as both an RT call and as a Windows call (for example, RtAtoi and Atoi). |
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
No |
||
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes |
|
|
|
No |
|
| No | ||
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
No | |
| RtMonitorControl |
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes | |
|
|
Yes | |
|
|
Yes | |
|
|
Yes | |
|
|
Yes | |
|
|
Yes | |
|
|
Yes | |
|
The IPC namespace is separate from the Windows namespace. |
No | |
|
The IPC namespace is separate from the Windows namespace. |
No | |
|
|
No | |
|
The IPC namespace is separate from the Windows namespace. |
No | |
|
|
No | |
| No | ||
|
The call is supported as both an RT call and as a Windows call (for example, RtAtoi and Atoi). |
No | |
|
The IPC namespace is separate from the Windows namespace. |
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes | |
|
|
Yes | |
| RtQueryProcessMSpace | Yes, if DumpLevel is 0. | |
| RtQuerySharedMemory | Yes | |
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
No | |
|
The IPC namespace is separate from the Windows namespace. |
Yes, unless the mutex has a higher priority thread waiting on it. |
|
|
The IPC namespace is separate from the Windows namespace. |
Yes, unless the semaphore has a higher priority thread waiting on it. |
|
|
|
No | |
|
The IPC namespace is separate from the Windows namespace. |
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. | |
|
|
Yes |
|
|
|
No | |
|
|
No |
|
|
The IPC namespace is separate from the Windows namespace. |
Yes, unless the event has a higher priority thread waiting on it. |
|
| Yes | ||
|
The call is supported as both an RT call and as a Windows call (for example, RtAtoi and Atoi). |
Yes |
|
|
RtSetProxyThreadPriority (can only be called by Windows applications linked with wRTOS) |
No | |
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
The priority spectrum of wRTOS is 0 to 127, whereas the Windows range is {-15, -2, -1, 0, 1, 2, 15}. The call is supported as both an RT call and as a Windows call (for example, RtAtoi and Atoi). |
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
| RtShrinkMSpace | No | |
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
No | |
|
|
No | |
|
|
No | |
|
|
Yes |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
The call is supported as both an RT call and as a Windows call (for example, RtAtoi and Atoi). |
No | |
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
|
Yes - the elapsed time for the call is less than 5 microseconds. | |
|
|
Yes - the elapsed time for the call is less than 5 microseconds. |
|
|
The call is supported as both an RT call and as a Windows call (for example, RtAtoi and Atoi). |
Yes - the elapsed time for the call is less than 5 microseconds. |
About #pragma deprecated Functions in Rtapi.h
The functions listed under #pragma deprecated in the real-time API, Rtapi.h, are unsupported, not deprecated. Listing them this way ensures that a warning appears in Visual Studio when a developer attempts to use an unsupported function in Visual Studio.
