RtfwGetLocalMemoryConfiguration

RtfwGetLocalMemoryConfiguration returns the Local Memory MSpaces configuration for the RTX64 Subsystem.

Syntax

bool RtfwGetLocalMemoryConfiguration(
    RTFW_LOCAL_MEMORY_CONFIGURATION * pConfiguration
);

Parameters

pConfiguration

A pointer to a RTFW_LOCAL_MEMORY_CONFIGURATION structure that is filled in with Local Memory MSpaces configuration information. This value cannot be NULL, and the user must set the Size member to sizeof(RTFW_LOCAL_MEMORY_CONFIGURATION), otherwise this API fails and sets the last error value to RT_ERROR_STRUCTURE_TOO_SMALL.

Return Value

The function returns true if it succeeds. Otherwise, it returns false, sets the last error value, and the data pointed to in pConfiguration is invalid. Call GetLastError for additional error information.

Possible error codes:

Error Code	Meaning
RT_ERROR_STRUCTURE_TOO_SMALL	The Size member of a structure is too small.

Remarks

If the Subsystem is running when the RtfwGetLocalMemoryConfiguration API is called, the values returned by this function may differ from the values currently in use by the Subsystem.

Requirements

Minimum Required Version	RTX64 4.0
Header	RtfwAPI.h
Library	RtfwAPI.lib