IDebugClient::AttachKernel method (dbgeng.h)

Article
10/21/2021

The AttachKernel methods connect the debugger engine to a kernel target.

Syntax

HRESULT AttachKernel(
  [in]           ULONG Flags,
  [in, optional] PCSTR ConnectOptions
);

Parameters

[in] Flags

Specifies the flags that control how the debugger attaches to the kernel target. The possible values are:

Value	Description
DEBUG_ATTACH_KERNEL_CONNECTION	Attach to the kernel on the target computer.
DEBUG_ATTACH_EXDI_DRIVER	Attach to a kernel by using an eXDI driver.

[in, optional] ConnectOptions

Specifies the connection settings for communicating with the computer running the kernel target. The interpretation of ConnectOptions depends on the value of Flags.

DEBUG_ATTACH_KERNEL_CONNECTION

ConnectOptions will be interpreted the same way as the options that follow the -k switch on the WinDbg and KD command lines. Environment variables affect ConnectOptions in the same way they affect the -k switch.

DEBUG_ATTACH_EXDI_DRIVER

eXDI drivers are not described in this documentation. If you have an eXDI interface to your hardware probe or hardware simulator, please contact Microsoft for debugging information.

Return value

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

Return code	Description
S_OK	The method was successful.

Remarks

Note The engine doesn't completely attach to the kernel until the WaitForEvent method has been called. Only after the kernel has generated an event -- for example, the initial breakpoint -- does it become available in the debugger session.

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

Requirements

Requirement	Value
Target Platform	Desktop
Header	dbgeng.h (include Dbgeng.h)