RtfwGetScheduledProcess

RtfwGetScheduledProcess retrieves the scheduled process definition at the given startup order.

Syntax

bool RtfwGetScheduledProcess(
	PRTFW_SCHEDULED_PROCESS ScheduledProcess;
	int order
);

Parameters

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.

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

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_SCHEDULED_PROCESS_NOT_FOUND Failed to find a scheduled process that matches the specified order.
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.

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 Required Version RTX64 3.5
Header RtfwAPI.h
Library RtfwAPI.lib

See Also:

RtfwCreateScheduledProcess

RtfwDeleteAllScheduledProcesses

RtfwDeleteScheduledProcessByID

RtfwGetCurrentScheduledProcessCount

RtfwGetPIDByScheduledID

RtfwModifyScheduledProcess

PRTFW_SCHEDULED_PROCESS