SetEngineOptions

The SetEngineOptions method changes the engine's options.

HRESULT
  IDebugControl::SetEngineOptions(
    IN ULONG  Options
    );

Parameters

Options

Specifies the engine's new options. Options is a bit-set; it will replace the existing symbol options. For a description of the engine options, see DEBUG_ENGOPT_XXX.

Return Value

S_OK

The method was successful.

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

Interface Version

SetEngineOptions is available in all versions of IDebugControl.

Comments

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

After the engine options have been changed, the engine sends out notification to each client's event callback object by passing the DEBUG_CES_ENGINE_OPTIONS flag to the IDebugEventCallbacks::ChangeEngineState method.

Requirements

Headers: Defined in Dbgeng.h. Include Dbgeng.h.

See Also

AddEngineOptions, GetEngineOptions, RemoveEngineOptions