RtcplLaunchRTSSProcess

Use RtcplLaunchRTSSProcess to launch a specified RTSS process.

Syntax

BOOL RtcplLaunchRTSSProcess (
    LPTSTR ApplicationName,
    LPTSTR CommandLine,
    DWORD LaunchFlags,
    DWORD ProcessorAffinity
    DWORD ProcessorAffinityMask,
    PDWORD ProcessId
);

Parameters

ApplicationName

Full path to the RTSS application to launch.

Cmdline

Command-line parameters needed to run the application.

LaunchFlags

Optional flags used when launching an RTSS application.

Flag	Description
LAUNCH_FLAG_LOCAL	Use local memory.
LAUNCH_FLAG_NONPAGED	Use non-paged memory.
LAUNCH_FLAG_AUTO_START	Register the process to run automatically at boot time. Note: This flag is only supported when the subsystem is set to run at boot time.
LAUNCH_FLAG_AFFINITY	Set the processor affinity for the ideal processor.
LAUNCH_FLAG_AFFINITY_MASK	Set the process affinity mask.

ProcessorAffinity

The number of the processor that will be used to run the main thread of the application. This parameter is only referenced if LAUNCH_FLAG_AFFINITY is set. Also, ProcessorAffinity has the following caveats:

If LAUNCH_FLAG_AFFINITY is set, the processor that you specify in ProcessorAffinity should also exist in the ProcessorAffinityMask. Specifying a processor that does not exist in the ProcessorAffinityMask will cause the function to fail.

If the LAUNCH_FLAG_AFFINITY flag is not set, this value is ignored and your process will be run on the default ideal processor, which is the least significant processor in the mask. For example, if your mask is (2,3,4), the process will run on Processor 2.

ProcessorAffinityMask

The mask of processors, in the form of a bitmask, that may be used for any of the process' child threads. This parameter is only referenced if LAUNCH_FLAG_AFFINITY_MASK is set. If you do not specify a ProcessorAffinityMask, the default processor mask for the RTSS system is used.

ProcessId

Pointer to a DWORD that RtcplLaunchRTSSProcess will populate with a Process ID if the call is successful.

Return Values

TRUE if RtcplLaunchRTSSProcess is able to launch the application, FALSE otherwise

If the call fails, use GetLastError for additional information.

Related RTSSRun GUI Features

This function corresponds to the following features in the RTSSRun GUI:

Register RTSS process
Use local memory pool
Register to run at boot time
Ideal processor
Affinity mask

Requirements

Header	RtxProp.h
Library	RtxProp.lib

| |