ShellExecute

From AutoIt Wiki

Jump to: navigation, search

Runs an external program using the ShellExecute API. Adapted from AutoIt docs.

Contents

Syntax

ShellExecute ( "filename" [, "parameters" [, "workingdir" [, "verb" [, showflag]]]] )

Parameters

filename The name of the file to run (EXE, .txt, .lnk, etc).
parameters [optional] Any parameters for the program. Blank ("") uses none.
workingdir [optional] The working directory. Blank ("") uses the current working directory.
verb [optional] The "verb" to use, common verbs include:

  default = Uses the default action as defined in the operating system
  "open" = Opens the file specified. The file can be an executable file, a document file, or a folder
  "edit" = Launches an editor and opens the document for editing. If "filename" is not a document file, the function will fail
  "print" = Prints the document file specified. If "filename" is not a document file, the function will fail
  "properties" = Displays the file or folder's properties
See remarks for more information on the default behavior when a verb is not specified.

showflag [optional] The "show" flag of the executed program:

  true (or no parameter) = Normal window (the default)
  @SW_HIDE = Hidden window
  @SW_MINIMIZE = Minimized window
  @SW_MAXIMIZE = Maximized window

Return Value

Success: Returns 1.
Failure: Returns 0 and sets @error to non-zero.

Remarks

After running the requested program the script continues. To pause execution of the script until the spawned program has finished use the ShellExecuteWait function instead.

When no verb is specified the default verb is used. The default verb is the verb configured in the registry. If no verb is set as default in the registry then the "open" verb is used. If the "open" verb is not present then the first verb listed in the registry is used (except on Windows 2000).

Related Functions

ShellExecuteWait, Run, RunWait, RunAsWait

Example

; Open Notepad
ShellExecute("Notepad.exe")
; Open a .txt file with it's default editor
ShellExecute("myfile.txt", "", @ScriptDir, "edit")
Personal tools