RtfwDeleteScheduledProcessByID deletes the scheduled process specified by an identifier.
Syntax
bool RtfwDeleteScheduledProcessByID(
[in] const RTFW_SCHEDULED_ID scheduledID
);Parameters
[in] scheduledID
Determines which scheduled process to delete. This parameter is retrieved within the structure through any get or create scheduled process function.
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_STRUCTURE_TOO_SMALL |
The member Size of a structure is too small. |
|
RT_ERROR_SCHEDULED_PROCESS_LOCK_FAILURE |
Failed to obtain the lock to serialize starting/stopping the wRTOS Subsystem. |
|
RT_ERROR_SCHEDULED_PROCESS_NOT_FOUND |
Failed to find a scheduled process with the given scheduledID. |
Remarks
This function has locking to allow for thread safety. It shares a lock with all other scheduled process functions.
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
wRTOS 1.0 SDK |
RtfwApi.h |
RtfwApi.lib |
See Also:
