IDebugControl3::ExecuteCommandFile method (dbgeng.h)

Article
02/22/2024

The ExecuteCommandFile method opens the specified file and executes the debugger commands that are contained within.

Syntax

HRESULT ExecuteCommandFile(
  [in] ULONG OutputControl,
  [in] PCSTR CommandFile,
  [in] ULONG Flags
);

Parameters

[in] OutputControl

Specifies where to send the output of the command. For possible values, see DEBUG_OUTCTL_XXX. For more information about output, see Input and Output.

[in] CommandFile

Specifies the name of the file that contains the commands to execute. This file is opened for reading and its contents are interpreted as if they had been typed into the debugger console.

[in] Flags

Specifies execution options for the command. The default options are to log the command but not to send it to the output. For details about the values that Flags can take, see Execute.

Return value

This method might also return error values, including error values caused by a failure to open the specified file. For more information, see Return Values.

Return code	Description
S_OK	The method was successful.

Remarks

This method reads the specified file and execute the commands one line at a time using Execute. If an exception occurred while executing a line, the execution will continue with the next line.

Requirements

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