Debugging Tools for Windows

SetKernelConnectionOptions

The SetKernelConnectionOptions and SetKernelConnectionOptionsWide methods update some of the connection options for a live kernel target.

HRESULT
  IDebugClient::SetKernelConnectionOptions(
    IN PCSTR  Options
    );

HRESULT
  IDebugClient5::SetKernelConnectionOptionsWide(
    IN PCWSTR  Options
    );

#ifdef UNICODE
#define SetKernelConnectionOptionsT SetKernelConnectionOptionsWide
#else
#define SetKernelConnectionOptionsT SetKernelConnectionOptions
#endif

Parameters

Options

Specifies the connection options to update. The possible values are:

Value	Description
"resync"	Re-synchronize the connection between the debugger engine and the kernel. For more information, see Synchronizing with the Target Computer.
"cycle_speed"	For kernel connections through a COM port, cycle through the supported baud rates; for other connections, do nothing. For more information, see CTRL+A (Toggle Baud Rate).

Return Value

S_OK: The method was successful.
E_UNEXPECTED: The current target is not a live (non-local) kernel target.

This method may also return error values. See Return Values for more details.

Interface Version

SetKernelConnectionOptions is available in all versions of IDebugClient. SetKernelConnectionOptionsWide is available in IDebugClient5 and later versions.

Comments

This method is available only for live kernel targets that are not local and not connected through eXDI. This method is reentrant.

For more information about connecting to live kernel-mode targets, see Live Kernel-Mode Targets.

Requirements