RtfwSetLocalMemoryConfiguration
RtfwSetLocalMemoryConfiguration sets the Local Memory MSpaces configuration for the RTX64 Subsystem and processes.
Syntax
bool RtfwSetLocalMemoryConfiguration(
const RTFW_LOCAL_MEMORY_CONFIGURATION * pConfiguration
);
Parameters
pConfiguration
A pointer to a RTFW_LOCAL_MEMORY_CONFIGURATION structure that specifies configuration parameters for the Local Memory MSpaces. This value cannot be NULL, and the size member 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
The function returns true if it succeeds. Otherwise, it returns false and sets the last error value. Call GetLastError for additional error information.
Possible error codes:
| Error Code | Meaning |
|---|---|
| RT_ERROR_RESTART_SUBSYSTEM |
The Subsystem was running when this function succeeded. RtfwRestartRequired will report that the RTX64 Subsystem must be restarted. NOTE: The RTX64 Subsystem must be restarted for the change to take effect. |
| RT_ERROR_STRUCTURE_TOO_SMALL | The Size member 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:
- Call the Get function.
- Modify the value(s) you want to change.
- Call the corresponding Set function.
The values passed in by the Set function will be saved (persistent).
Requirements
| Minimum Required Version | RTX64 4.0 |
| Header | RtfwAPI.h |
| Library | RtfwAPI.lib |
See Also:
