RtfwGetScheduledProcess retrieves the scheduled process definition at the given startup order.
Syntax
bool RtfwGetScheduledProcess(
[in, out] PRTFW_SCHEDULED_PROCESS ScheduledProcess;
[in] int order
);Parameters
[in, out] ScheduledProcess
A pointer to an RTFW_SCHEDULED_PROCESS structure that will be filled with information of the scheduled process with the specified order, if found.
[in] order
The zero-based order value at which the desired scheduled process starts in the context of all processes scheduled to run at Subsystem startup.
Return Value
If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code.
Possible error codes:
| Error code | Meaning |
|---|---|
|
ERROR_INVALID_PARAMETER |
One of the parameters of this function is NULL, or a field within the structure is invalid. |
|
RT_ERROR_SCHEDULED_PROCESS_NOT_FOUND |
Failed to find a scheduled process that matches the specified order. |
|
RT_ERROR_STRUCTURE_TOO_SMALL |
The member Size of a structure is too small. |
|
RT_ERROR_SCHEDULED_PROCESS_LOCK_FAILURE |
Failed to obtain the lock. |
Remarks
This function has locking to allow for thread safety. It shares a lock with all other scheduled process functions.
If the Subsystem is running when the RtfwGetLocalMemoryConfiguration API is called, the values returned by this function may differ from the values currently in use by the Subsystem.
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
wRTOS 1.0 SDK |
RtfwApi.h |
RtfwApi.lib |
See Also:
