RtfwSetRemoteDebuggerConfiguration

RtfwSetRemoteDebuggerConfiguration sets the wRTOS remote debugger configuration.

Syntax

Copy

bool RtfwSetRemoteDebuggerConfiguration(
    [in]    RTFW_REMOTE_DEBUGGER_CONFIGURATION * pConfiguration
);

Parameters

[in] pRemoteDebuggerConfiguration

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

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code.

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
RT_ERROR_INVALID_REMOTE_DEBUGGER_HOST_PORT	This error occurs when the specified port is out of range and/or the port is in use.
RT_ERROR_INVALID_REMOTE_DEBUGGER_TARGET_NAME	This error occurs if the name from the URI in use doesn’t match the name of the target system or the loopback interface.
RT_ERROR_INVALID_REMOTE_DEBUGGER_TARGET_PORT	This error occurs if the host port from the URI in use doesn’t match the port number in the pConfiguration struct.

Remarks

For any changes to take effect prior to a system restart, you must call RtfwRemoteDebuggerStartListening. If remote connections are already active, you must first call RtfwRemoteDebuggerStopListening before calling RtfwRemoteDebuggerStartListening.

Requirements

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