SetSymbolOptions

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

HRESULT
  IDebugSymbols::SetSymbolOptions(
    IN PULONG  Options
    );

Parameters

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

S_OK

The method was successful.

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

Interface Version

SetSymbolOptions is available in all versions of IDebugSymbols.

Comments

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

Headers: Defined in Dbgeng.h. Include Dbgeng.h. The options are defined in Dbghelp.h.

See Also

AddSymbolOptions, GetSymbolOptions, RemoveSymbolOptions