RtfwSetLocalMemoryConfiguration

RtfwSetLocalMemoryConfiguration sets the Local Memory MSpaces configuration for the wRTOS Subsystem and processes.

Syntax

Copy 
bool RtfwSetLocalMemoryConfiguration(
    [in]    const RTFW_LOCAL_MEMORY_CONFIGURATION * pConfiguration
);

Parameters

[in] pConfiguration

A pointer to an RTFW_LOCAL_MEMORY_CONFIGURATION structure that specifies configuration parameters for the Local Memory MSpaces. This value cannot be NULL, and the member Size must be set 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. Call GetLastError to obtain an error code.

Possible error codes:

Error code Meaning

RT_ERROR_RESTART_SUBSYSTEM

The Subsystem was running when this function succeeded. RtfwRestartRequired will report that the wRTOS Subsystem must be restarted.

Note: The wRTOS Subsystem must be restarted for the change to take effect.

RT_ERROR_STRUCTURE_TOO_SMALL

The member Size of a structure is too small.

Remarks

The following is the best practice for using Native Library Get/Set APIs that take structures as arguments:

  1. Call the Get function.
  2. Modify the value(s) you want to change.
  3. Call the corresponding Set function.

The values passed in by the Set function will be saved (persistent).

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtfwApi.h

RtfwApi.lib

See Also: