GetKernelConnectionOptions

The GetKernelConnectionOptions and GetKernelConnectionOptionsWide methods return the connection options for the current kernel target.

HRESULT
  IDebugClient::GetKernelConnectionOptions(
    OUT OPTIONAL PSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  OptionsSize
    );

HRESULT
  IDebugClient5::GetKernelConnectionOptionsWide(
    OUT OPTIONAL PWSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  OptionsSize
    );

#ifdef UNICODE
#define GetKernelConnectionOptionsT GetKernelConnectionOptionsWide
#else
#define GetKernelConnectionOptionsT GetKernelConnectionOptions
#endif

Parameters

Buffer

Specifies the buffer to receive the connection options.

BufferSize

Specifies the size in characters of the buffer Buffer.

OptionsSize

Receives the size in characters of the connection options. If OptionsSize is NULL, this information is not returned.

Return Value

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.

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

Interface Version

GetKernelConnectionOptions is available in all versions of IDebugClient. GetKernelConnectionOptionsWide 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.

The connection options returned are the same options used to connect to the kernel. For details on the syntax of this string, see Choosing Kernel Debugging Settings.

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

Requirements

Headers: Defined in dbgeng.h. Include dbgeng.h.

See Also

AttachKernel, Choosing Kernel Debugging Settings