RtcplGetUseLocalMemoryByDefault

The function RtcplGetUseLocalMemoryByDefault retrieves the default memory allocation behavior.

Syntax

BOOL RtcplGetUseLocalMemoryByDefault(
    PDWORD Enable
);

Parameters

Enable

Pointer to a DWORD that RtcplGetUseLocalMemoryByDefault populates with one of the following defines:

Value

Description

GENERAL_ENABLE

Use local memory by default is enabled. 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

Use local memory by default is disabled. All RTSS applications request memory from Windows by default.

Return Values

A non-zero value if the function succeeds

Remarks

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