RtfwSetRemoteDebuggerConfiguration
RtfwSetRemoteDebuggerConfiguration sets the RTX64 remote debugger configuration.
Syntax
bool RtfwSetRemoteDebuggerConfiguration( RTFW_REMOTE_DEBUGGER_CONFIGURATION * pConfiguration );
Parameters
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
The function returns true if it succeeds. Otherwise, it returns false and sets the last error value. Call GetLastError for additional error information.
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 Required Version | RTX64 4.1 |
Header | RtfwAPI.h |
Library | RtfwAPI.lib |
See Also:
RtfwGetRemoteDebuggerConfiguration
RTFW_REMOTE_DEBUGGER_CONFIGURATION