RtcplSetUseLocalMemoryByDefault

The function RtcplSetUseLocalMemoryByDefault configures default memory allocation behavior.

Syntax

BOOL RtcplSetUseLocalMemoryByDefault(
    DWORD Enable
);

Parameters

Enable

Specifies whether to use local memory by default.

Value

Description

GENERAL_ENABLE

Makes all RTSS applications request memory from the RTX local memory pool by default. RTX creates the local memory pool the first time someone uses RTSSrun with the /l flag or the first time they run an RTSS application that calls RtAllocateLocalMemory.

GENERAL_DISABLE

Makes all RTSS applications request memory from Windows by default.

Return Values

A non-zero value if the function succeeds

Remarks

Changing this value requires a restart of the RTX Subsystem if it is running, as indicated by a GetLastError of ERROR_SUCCESS_RESTART_REQUIRED.

Local memory is a memory pool that RTX deterministically allocates to fulfill all RTSS application memory requests. RTSS applications that allocate memory from the local pool don't have to initiate a Service Request Interrupt (SRI) to request memory from Windows. For more details about using local memory with RTX, see Local Memory.

Related RTX Properties Control Panel Features

Tab

Memory tab

Feature(s)

Allocation options

Requirements

Header RtxProp.h
Library RtxProp.lib
IntervalZero.com | Support | Give Feedback