RtfwGetSubsystemConfiguration

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

Syntax

bool RtfwGetSubsystemConfiguration(
    RTFW_SUBSYSTEM_CONFIGURATION * pSubsystemConfiguration
);

Parameters

pSubsystemConfiguration

A pointer to a RTFW_SUBSYSTEM_CONFIGURATION structure that is filled in with the core Subsystem configuration. This value cannot be NULL, and the Size member 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

The function returns true if it succeeds. Otherwise, it returns false, sets the last error value, and leaves the structure pointed to by pSubsystemConfiguration with invalid member content. 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 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 Required Version	RTX64 3.4
Header	RtfwAPI.h
Library	RtfwAPI.lib