RtfwGetRemoteDebuggerConfiguration

RtfwGetRemoteDebuggerConfiguration retrieves the wRTOS remote debugger configuration.

Syntax

Copy

bool RtfwGetRemoteDebuggerConfiguration(
    [out]   RTFW_REMOTE_DEBUGGER_CONFIGURATION *pConfiguration
);

Parameters

[out] pRemoteDebuggerConfiguration

Points to structure RTFW_REMOTE_DEBUGGER_CONFIGURATION that will be filled in with the wRTOS remote debugger configuration settings. This pointer cannot be NULL and member Size must be set by the caller to the value sizeof(RTFW_CONSOLE_CONFIGURATION).

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE, sets the last error value, and leaves the memory pointed to by pConfiguration undefined. Call GetLastError to obtain an error code.

If the Subsystem is running when the RtfwSetRemoteDebuggerConfiguration API is called, the values returned by this function may differ from the values currently in use by the Subsystem.

Possible Error codes

Error code	Meaning
RT_ERROR_STRUCTURE_TOO_SMALL	This error occurs when member Size in the structure passed to the get/set APIs is not set to sizeof(RTFW_REMOTE_DEBUGGER_CONFIGURATION).
ERROR_INVALID_PARAMETER	This error occurs when parameter pConfiguration is NULL.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtfwApi.h	RtfwApi.lib