IDebugAdvanced3::Request method (dbgeng.h)

Article
10/21/2021

The Request method performs a variety of different operations.

Syntax

HRESULT Request(
  [in]            ULONG  Request,
  [in, optional]  PVOID  InBuffer,
  [in]            ULONG  InBufferSize,
  [out, optional] PVOID  OutBuffer,
  [in]            ULONG  OutBufferSize,
  [out, optional] PULONG OutSize
);

Parameters

[in] Request

Specifies which operation to perform. Request can be one of the values in the following table. Details of each operation can be found by following the link in the "Request" column.

Request	Action
DEBUG_REQUEST_SOURCE_PATH_HAS_SOURCE_SERVER	Check the source path for a source server.
DEBUG_REQUEST_TARGET_EXCEPTION_CONTEXT	Return the thread context for the stored event in a user-mode minidump file.
DEBUG_REQUEST_TARGET_EXCEPTION_THREAD	Return the operating system thread ID for the stored event in a user-mode minidump file.
DEBUG_REQUEST_TARGET_EXCEPTION_RECORD	Return the exception record for the stored event in a user-mode minidump file.
DEBUG_REQUEST_GET_ADDITIONAL_CREATE_OPTIONS	Return the default process creation options.
DEBUG_REQUEST_SET_ADDITIONAL_CREATE_OPTIONS	Set the default process creation options.
DEBUG_REQUEST_GET_WIN32_MAJOR_MINOR_VERSIONS	Return the version of Windows that is currently running on the target.
DEBUG_REQUEST_READ_USER_MINIDUMP_STREAM	Read a stream from a user-mode minidump target.
DEBUG_REQUEST_TARGET_CAN_DETACH	Check to see if it is possible for the debugger engine to detach from the current process (leaving the process running but no longer being debugged).
DEBUG_REQUEST_SET_LOCAL_IMPLICIT_COMMAND_LINE	Set the debugger engine's implicit command line.
DEBUG_REQUEST_GET_CAPTURED_EVENT_CODE_OFFSET	Return the current event's instruction pointer.
DEBUG_REQUEST_READ_CAPTURED_EVENT_CODE_STREAM	Return up to 64 bytes of memory at the current event's instruction pointer.
DEBUG_REQUEST_EXT_TYPED_DATA_ANSI	Perform a variety of different operations that aid in the interpretation of typed data.

[in, optional] InBuffer

Specifies the input to this method. The type and interpretation of the input depends on the Request parameter.

[in] InBufferSize

Specifies the size of the input buffer InBuffer. If the request requires no input, InBufferSize should be set to zero.

[out, optional] OutBuffer

Receives the output from this method. The type and interpretation of the output depends on the Request parameter. If OutBuffer is NULL, the output is not returned.

[in] OutBufferSize

Specifies the size of the output buffer OutBufferSize. If the type of the output returned to OutBuffer has a known size, OutBufferSize is usually expected to be exactly that size, even if OutBuffer is set to NULL.

[out, optional] OutSize

Receives the size of the output returned in the output buffer OutBuffer. If OutSize is NULL, this information is not returned.

Return value

The interpretation of the return value depends on the value of the Request parameter. Unless otherwise stated, the following values may be returned.

Return code	Description
S_OK	The method was successful.
S_FALSE	The method was successful. However, the output would not fit in the output buffer OutBuffer, so truncated output was returned.
E_INVALIDARG	The size of the input buffer InBufferSize or the size of the output buffer OutBufferSize was not the expected value.

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

Requirements

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

IDebugAdvanced3::Request method (dbgeng.h)

Syntax

Parameters

Return value

Requirements

See also

Feedback

Feedback

Additional resources