Edit

Share via

IDebugSymbolSearchEvent2::GetSymbolSearchInfo

  • Article

Called by an event handler to retrieve results about a symbol load process.

Syntax

int GetSymbolSearchInfo(
   IDebugModule3              pModule,
   ref string                 pbstrDebugMessage,
   out enum_MODULE_INFO_FLAGS pdwModuleInfoFlags
);

Parameters

pModule
[out] An IDebugModule3 object representing the module for which the symbols were loaded.

pbstrDebugMessage
[in, out] Returns a string containing any error messages from the module. If there is no error, then this string will just contain the module's name but it is never empty.

Note

[C++] pbstrDebugMessage cannot be NULL and must be freed with SysFreeString.

pdwModuleInfoFlags
[out] A combination of flags from the MODULE_INFO_FLAGS enumeration indicating whether any symbols were loaded.

Return Value

If successful, returns S_OK; otherwise returns an error code.

Remarks

When a handler receives the IDebugSymbolSearchEvent2 event after an attempt is made to load debugging symbols for a module, the handler can call this method to determine the results of that load.

See also