RtcplSetAutoExpandLocalPool

The function RtcplSetAutoExpandLocalPool determines whether or not the local memory pool automatically expands when a memory allocation request requires more memory than is available in the local memory pool.

Syntax

BOOL RtcplSetAutoExpandLocalPool(
    DWORD Enable
);

Parameters

Enable

One of the following values:

Value

Description

GENERAL_ENABLE

Causes the local memory pool to automatically expand when a memory allocation request requires more memory than is available in the local memory pool. The minimum size by which it expands defaults to 4096 bytes and can be configured using the function RtcplSetLocalPoolExpansionSize.

Warning: Expansion of the local memory pool is a non-deterministic operation. Enabling automatic expansion can cause an otherwise deterministic application to become non-deterministic.

GENERAL_DISABLE

Prevents the local memory pool from expanding when it is exhausted.

Warning: This can cause memory allocations to fail if there is insufficient space in the local memory pool to satisfy the memory allocation request.

Return Values

A TRUE value 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.

By default, the local memory pool automatically expands when the initial size of the pool is exhausted. Once the expanded memory is no longer being used after a pool expansion occurs, the RTX Subsystem returns the memory to Windows and resets the local memory pool to its initial size.

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