RtShrinkLocalMemory

RtShrinkLocalMemory shrinks the RTSS local memory pool up to the size specified.

Syntax

ULONG RtShrinkLocalMemory(
   ULONG Size
);

Parameters

Size

An unsigned long specifying the number of bytes to shrink the RTSS local memory pool by.

Return Value

The number of bytes by which the RTSS local memory pool has actually shrunk.

Remarks

RtShrinkLocalMemory allows you to explicitly shrink the RTSS local memory pool. It decreases the free memory in the local memory pool and returns back to Windows non-paged memory. If there is not enough free memory in the RTSS local memory pool,or if the pool size will be below the local memory pool configured via the RTX64 Control Panel, then the number of bytes it will shrink by may be less than the Size requested. Note that there is SRI activity involved within the RtShrinkLocalMemory call, and it cannot be called when a shutdown occurs.

NOTE: The RTSS local memory pool will shrink automatically whenever an RTSS process exits. This implicit shrink will decrease the free memory in the RTSS local memory pool. However, it will not shrink the pool size below the local memory pool configured via the RTX64 Control Panel. You can disable this automatic shrink feature in the RTX64 Control Panel.

Requirements

Minimum Supported Version RTX64 2013 with Service Pack 1
Header RtssApi.h
Library Rtx_Rtss.lib