IDebugClient::GetKernelConnectionOptions method (dbgeng.h)

Article
02/22/2024

The GetKernelConnectionOptions method returns the connection options for the current kernel target.

Syntax

HRESULT GetKernelConnectionOptions(
  [out, optional] PSTR   Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG OptionsSize
);

Parameters

[out, optional] Buffer

Specifies the buffer to receive the connection options.

[in] BufferSize

Specifies the size in characters of the buffer Buffer. This size includes the space for the '\0' terminating character.

[out, optional] OptionsSize

Receives the size in characters of the connection options. This size includes the space for the '\0' terminating character. If OptionsSize is NULL, this information is not returned.

Return value

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

Return code	Description
S_OK	The method was successful.
S_FALSE	The size of the string was greater than the size of the buffer, so it was truncated to fit into the buffer.
E_UNEXPECTED	The current target is not a standard live kernel target.

Remarks

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

The connection options returned are the same options used to connect to the kernel.

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)