RtfwGetRemoteDebuggerConfiguration

RtfwGetRemoteDebuggerConfiguration retrieves the RTX64 remote debugger configuration.

Syntax

bool RtfwGetRemoteDebuggerConfiguration(
    RTFW_REMOTE_DEBUGGER_CONFIGURATION *pConfiguration
);

Parameters

pRemoteDebuggerConfiguration

Points to structure RTFW_REMOTE_DEBUGGER_CONFIGURATION that will be filled in with the RTX64 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

The function returns true if it succeeds. Otherwise, it returns false, sets the last error value, and leaves the memory pointed to by pConfiguration undefined. Call GetLastError for additional error information.

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 Required Version	RTX64 4.1
Header	RtfwAPI.h
Library	RtfwAPI.lib