IDebugEventCallbacks::LoadModule method (dbgeng.h)

Article
10/21/2021

The LoadModule callback method is called by the engine when a module-load debugging event occurs in the target.

Syntax

HRESULT LoadModule(
  [in]           ULONG64 ImageFileHandle,
  [in]           ULONG64 BaseOffset,
  [in]           ULONG   ModuleSize,
  [in, optional] PCSTR   ModuleName,
  [in, optional] PCSTR   ImageName,
  [in]           ULONG   CheckSum,
  [in]           ULONG   TimeDateStamp
);

Parameters

[in] ImageFileHandle

Specifies the handle to the module's image file. If this information is not available, ImageFileHandle will be NULL.

[in] BaseOffset

Specifies the base address of the module in the target's memory address space. If this information is not available, BaseOffset will be NULL.

[in] ModuleSize

Specifies the module's image size in bytes. If this information is not available, ModuleSize will be NULL.

[in, optional] ModuleName

Specifies the simplified module name that is used by the debugger engine. In most cases, this matches the image file name excluding the extension. If this information is not available, ModuleName will be NULL.

[in, optional] ImageName

Specifies the module's image file name, which can include the path. If this information is not available, ImageName will be NULL.

[in] CheckSum

Specifies the checksum of the module's image file. If this information is not available, CheckSum will be NULL.

[in] TimeDateStamp

Specifies the time and date stamp of the module's image file. If this information is not available, TimeDateStamp will be zero.

Return value

This method returns a DEBUG_STATUS_XXX value, which indicates how the execution of the target should proceed after the engine processes this event. For details on how the engine treats this value, see Monitoring Events.

Remarks

This method is only called by the engine if the DEBUG_EVENT_LOAD_MODULE flag is set in the mask returned by IDebugEventCallbacks::GetInterestMask.

After calling this method, the engine will call IDebugEventCallbacks::ChangeSymbolState, with the Flags parameter containing the bit flag DEBUG_CSS_LOADS.

For more information about handling events, see Monitoring Events.

Requirements

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

Share via