Export (0) Print
Expand All

IDebugClient::GetKernelConnectionOptions method

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

Buffer [out, optional]

Specifies the buffer to receive the connection options.

BufferSize [in]

Specifies the size in characters of the buffer Buffer.

OptionsSize [out, optional]

Receives the size in characters of the connection options. 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 codeDescription
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

Header

Dbgeng.h (include Dbgeng.h)

See also

IDebugClient
IDebugClient2
IDebugClient3
IDebugClient4
IDebugClient5
AttachKernel

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft