RtfwGetLocalMemoryConfiguration

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

Syntax

Copy

bool RtfwGetLocalMemoryConfiguration(
    [out]   RTFW_LOCAL_MEMORY_CONFIGURATION * pConfiguration
);

Parameters

[out] pConfiguration

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

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE, sets the last error value, and the data pointed to in pConfiguration is invalid. Call GetLastError to obtain an error code.

Possible error codes:

Error code	Meaning
RT_ERROR_STRUCTURE_TOO_SMALL	The member Size 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 supported version	Header	Library
wRTOS 1.0 SDK	RtfwApi.h	RtfwApi.lib