IDebugSymbols::SetSymbolOptions method (dbgeng.h)

Article
02/22/2024

The SetSymbolOptions method changes the engine's global symbol options.

Syntax

HRESULT SetSymbolOptions(
  [in] ULONG Options
);

Parameters

[in] Options

Specifies the new symbol options. Options is a bit-set; it will replace the existing symbol options. For a description of the bit flags, see Setting Symbol Options.

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

This method will set the engine's global symbol options to those specified in Options. Unlike AddSymbolOptions, any symbol options not in the bit-set Options will be removed.

After the symbol options have been changed, for each client the engine sends out notification to that client's IDebugEventCallbacks by passing the DEBUG_CES_SYMBOL_OPTIONS flag to the IDebugEventCallbacks::ChangeSymbolState method.

For more information about symbols, see Symbols.

Requirements

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