Edit

Share via

IDebugControl4::GetStoredEventInformation method (dbgeng.h)

  • Article

The GetStoredEventInformation method retrieves information about an event of interest available in the current target.

Syntax

HRESULT GetStoredEventInformation(
  [out]           PULONG Type,
  [out]           PULONG ProcessId,
  [out]           PULONG ThreadId,
  [out, optional] PVOID  Context,
  [in]            ULONG  ContextSize,
  [out, optional] PULONG ContextUsed,
  [out, optional] PVOID  ExtraInformation,
  [in]            ULONG  ExtraInformationSize,
  [out, optional] PULONG ExtraInformationUsed
);

Parameters

[out] Type

Receives the type of the stored event. For a list of possible types, see DEBUG_EVENT_XXX.

[out] ProcessId

Receives the process ID of the process in which the event occurred. If this information is not available, DEBUG_ANY_ID will be returned instead.

[out] ThreadId

Receives the thread ID of the thread in which the last event occurred. If this information is not available, DEBUG_ANY_ID will be returned instead.

[out, optional] Context

Receives the thread context of the stored event. The type of the thread context is the CONTEXT structure for the target's effective processor at the time of the event. The Context buffer must be large enough to hold this structure. If Context is NULL, this information is not returned.

[in] ContextSize

Specifies the size, in bytes, of the buffer that Context specifies.

[out, optional] ContextUsed

Receives the size in bytes of the context. If ContextUsed is NULL, this information is not returned.

[out, optional] ExtraInformation

Receives extra information about the event. The contents of this extra information depends on the type of the event. If ExtraInformation is NULL, this information is not returned.

[in] ExtraInformationSize

Specifies the size, in bytes, of the buffer that ExtraInformation specifies.

[out, optional] ExtraInformationUsed

Receives the size in bytes of extra information. If ExtraInformationUsed 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.

Remarks

Many targets do not have an event of interest.

If the target is a user-mode minidump file, the dump file generator may store an additional event. Typically, this is the event that provoked the generator to save the dump file.

For more information, see the topic Event Information.

Requirements

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

See also

GetLastEventInformation

IDebugControl4