RtfwGetSubsystemConfiguration

RtfwGetSubsystemConfiguration returns the core wRTOS Subsystem configuration. See structure RTFW_SUBSYSTEM_CONFIGURATION. Other Subsystem configuration parameters can be obtained using other functions in this library.

Syntax

Copy

bool RtfwGetSubsystemConfiguration(
    [in]    RTFW_SUBSYSTEM_CONFIGURATION * pSubsystemConfiguration
);

Parameters

[in] pSubsystemConfiguration

A pointer to an RTFW_SUBSYSTEM_CONFIGURATION structure that is filled in with the core Subsystem configuration. This value cannot be NULL, and the member Size must be set to sizeof(RTFW_SUBSYSTEM_CONFIGURATION), otherwise this function 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 leaves the structure pointed to by pSubsystemConfiguration with invalid member content. 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 RtfwSetSubsystemConfiguration API is called, the values returned by this function may differ from the values currently in use by the Subsystem.

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