RtcplGetAutoExpandLocalPool

The function RtcplGetAutoExpandLocalPool retrieves the behavior of the local memory pool when it is exhausted.

Syntax

BOOL RtcplGetAutoExpandLocalPool(
    PDWORD Enable
);

Parameters

Enable

Pointer to a memory location that is populated with one of the following values:

Value

Description

GENERAL_ENABLE

Indicates that the local memory pool will automatically expand when it is exhausted. The minimum size by which it expands can be retrieved using the function RtcplGetLocalPoolExpansionSize.

GENERAL_DISABLE

Indicates that the local memory pool will not expand when it is exhausted.

Return Values

A value of TRUE if the function succeeds, otherwise FALSE.

Remarks

Changing this value may require 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 maintains to deterministically fulfill RTSS application memory requests. RTSS applications that allocate memory from the local pool don't have to request memory from Windows during each memory allocation. For more information on using local memory with RTX, see Local Memory.

Related RTX Properties Control Panel Features

Tab

Memory tab

Feature(s)

Local Memory Pool options

Requirements

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