RtcplGetLocalPoolExpansionSize

The function RtcplGetLocalPoolExpansionSize retrieves the minimum size, in bytes, by which the local memory pool expands when it is exhausted.

Syntax

BOOL RtcplGetLocalPoolExpansionSize(
    PDWORD Size
);

Parameters

Size

A pointer to a memory location populated with the minimum number of bytes by which the local memory pool will expand when it is exhausted.

Return Values

TRUE value if the function succeeds, otherwise FALSE.

Remarks

If you allocate more memory than the specified minimum expansion size, the system will request the larger memory size from Windows, rather than make multiple requests of the smaller expansion size. For instance, if the expansion size is set to the default 4096 bytes, and you were to allocate 10000 bytes of memory, the system would request the full 10000 bytes from Windows, rather than make multiple requests of the 4096 expansion size to cover the requested amount.

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