RtfwModifyScheduledProcess

RtfwModifyScheduledProcess modifies an existing scheduled process.

Syntax

Copy
bool RtfwModifyScheduledProcess(
    [in]    const RTFW_SCHEDULED_PROCESS * ScheduledProcess;
    [in]    int* reserved
);

Parameters

[in] ScheduledProcess

Pointer to the PRTFW_SCHEDULED_PROCESS structure that will be modified through this function. ScheduledID field is used to determine what scheduled process to modify.

[in] reserved

Reserved.

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

RT_ERROR_INVALID_AFFINITY_MASK

An invalid affinity mask was specified.

RT_ERROR_INVALID_IDEAL_PROCESSOR

An invalid ideal processor was specified.

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 Size member of a structure is too small.

RT_ERROR_SCHEDULED_PROCESS_NOT_FOUND

Failed to find a scheduled process that matches the specified ScheduledID.

Remarks

This function cannot be used to change the order of scheduled processes. To reorder the list of scheduled processes, delete and then insert the Scheduled Process into its new position.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtfwApi.h

RtfwApi.lib

See Also: