RtfwDeleteScheduledProcessByID

RtfwDeleteScheduledProcessByID deletes the scheduled process specified by an identifier.

Syntax

bool RtfwDeleteScheduledProcessByID(
    const RTFW_SCHEDULED_ID scheduledID
);

Parameters

scheduledID

Determines which scheduled process to delete. This parameter is retrieved within the structure through any get or create scheduled process function.

Return Value

The function returns true if it succeeds. Otherwise, it returns false. Call GetLastError for additional error information.

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 Size member of a structure is too small.
RT_ERROR_SCHEDULED_PROCESS_LOCK_FAILURE	Failed to obtain the lock to serialize starting/stopping the RTX64 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 Required Version	RTX64 3.5
Header	RtfwAPI.h
Library	RtfwAPI.lib