Platforms to show: All Mac Windows Linux Cross-Platform

WindowsShellExecuteMBS(ParentWindowHandle as Integer, Operation as string, File as string, Parameters as string = "", Directory as string = "", ShowCmd as Integer = 5) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
global method Windows MBS Win Plugin 10.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Performs an operation on a specified file.
Example
dim e as Integer
dim f as FolderItem

// show documents folder

f = SpecialFolder.Documents
e = WindowsShellExecuteMBS(0, "explore", f.NativePath, "", "", 10)

// Launch Notepad application

e = WindowsShellExecuteMBS(0, "", "notepad.exe", "", "", 10)

// launch file, folder or application

f = SpecialFolder.Desktop.Child("Auto1.JPG")
e = WindowsShellExecuteMBS(0, "", f.NativePath, "", "", 10)

Use ConsoleExecuteMBS on Mac OS X and Linux.

ParentWindowHandle:
A handle to the owner window used for displaying a UI or error messages. This value can be 0 if the operation is not associated with a window. You can pass window.handle from a Xojo window.

Operation:
A string, referred to in this case as a verb, that specifies the action to be performed. The set of available verbs depends on the particular file or folder. Generally, the actions available from an object's shortcut menu are available verbs. The following verbs are commonly used:

editLaunches an editor and opens the document for editing. If File is not a document file, the function will fail.
exploreExplores a folder specified by File.
findInitiates a search beginning in the directory specified by Directory.
openOpens the item specified by the File parameter. The item can be a file or folder.
printPrints the file specified by File. If File is not a document file, the function fails.
""In systems prior to Windows 2000, the default verb is used if it is valid and available in the registry. If not, the "open" verb is used. In Windows 2000 and later, the default verb is used if available. If not, the "open" verb is used. If neither verb is available, the system uses the first verb listed in the registry.

File:
A string that specifies the file or object on which to execute the specified verb. To specify a Shell namespace object, pass the fully qualified parse name. Note that not all verbs are supported on all objects. For example, not all document types support the "print" verb. If a relative path is used for the Directory parameter do not use a relative path for File.

Parameters:
If File specifies an executable file, this parameter is a string that specifies the parameters to be passed to the application. The format of this string is determined by the verb that is to be invoked. If File specifies a document file, Parameters should be "".

Directory:
A string that specifies the default (working) directory for the action. If this value is NULL, the current working directory is used. If a relative path is provided at File, do not use a relative path for Directory.

ShowCmd:
The flags that specify how an application is to be displayed when it is opened. If File specifies a document file, the flag is simply passed to the associated application. It is up to the application to decide how to handle it.

SW_HIDE0Hides the window and activates another window.
SW_MAXIMIZE3Maximizes the specified window.
SW_MINIMIZE6Minimizes the specified window and activates the next top-level window in the z-order.
SW_RESTORE9Activates and displays the window. If the window is minimized or maximized, Windows restores it to its original size and position. An application should specify this flag when restoring a minimized window.
SW_SHOW5Activates the window and displays it in its current size and position.
SW_SHOWDEFAULT10Sets the show state based on the SW_ flag specified in the STARTUPINFO structure passed to the CreateProcess function by the program that started the application. An application should call ShowWindow with this flag to set the initial show state of its main window.
SW_SHOWMAXIMIZED3Activates the window and displays it as a maximized window.
SW_SHOWMINIMIZED2Activates the window and displays it as a minimized window.
SW_SHOWMINNOACTIVE7Displays the window as a minimized window. The active window remains active.
SW_SHOWNA8Displays the window in its current state. The active window remains active.
SW_SHOWNOACTIVATE4Displays a window in its most recent size and position. The active window remains active.
SW_SHOWNORMAL1Activates and displays a window. If the window is minimized or maximized, Windows restores it to its original size and position. An application should specify this flag when displaying the window for the first time.

Return Value:
If the function succeeds, it returns a value greater than 32. If the function fails, it returns an error value that indicates the cause of the failure. The return value is cast as an HINSTANCE for backward compatibility with 16-bit Windows applications.

Return codeDescription
0The operating system is out of memory or resources.
ERROR_FILE_NOT_FOUND = 2The specified file was not found.
ERROR_PATH_NOT_FOUND = 3The specified path was not found.
ERROR_BAD_FORMAT = 11The .exe file is invalid (non-Win32 .exe or error in .exe image).
SE_ERR_ACCESSDENIED = 5The operating system denied access to the specified file.
SE_ERR_ASSOCINCOMPLETE = 27The file name association is incomplete or invalid.
SE_ERR_DDEBUSY = 30The DDE transaction could not be completed because other DDE transactions were being processed.
SE_ERR_DDEFAIL = 29The DDE transaction failed.
SE_ERR_DDETIMEOUT = 28The DDE transaction could not be completed because the request timed out.
SE_ERR_DLLNOTFOUND = 32The specified DLL was not found.
SE_ERR_FNF = 2The specified file was not found.
SE_ERR_NOASSOC = 31There is no application associated with the given file name extension. This error will also be returned if you attempt to print a file that is not printable.
SE_ERR_OOM = 8There was not enough memory to complete the operation.
SE_ERR_PNF = 3The specified path was not found.
SE_ERR_SHARE = 26A sharing violation occurred.

This method allows you to execute any commands in a folder's shortcut menu or stored in the registry.
To open a folder, use either of the following calls:

WindowsShellExecuteMBS(handle, "", <fully_qualified_path_to_folder>, "", "", SW_SHOWNORMAL);
or
WindowsShellExecuteMBS(handle, "open", <fully_qualified_path_to_folder>, "", "", SW_SHOWNORMAL);

To explore a folder, use the following call:
WindowsShellExecuteMBS(handle, "explore", <fully_qualified_path_to_folder>, "", "", SW_SHOWNORMAL);
To launch the Shell's Find utility for a directory, use the following call.

WindowsShellExecuteMBS(handle, "find", <fully_qualified_path_to_folder>, "", "", 0);

If Operation is empty, the function opens the file specified by File. If Operation is "open" or "explore", the function attempts to open or explore the folder.

Note The Launch folder windows in a separate process setting in Folder Options affects ShellExecute. If that option is disabled (the default setting), ShellExecute uses an open Explorer window rather than launch a new one. If no Explorer window is open, ShellExecute launches a new one.

See also ConsoleExecuteMBS, WindowsShellExecuteAsAdminMBS, WindowsProcessMBS (Windows only), NSTask (Mac only) and ShellMBS (cross platform).

Some FAQ entries about this method:

The items on this page are in the following plugins: MBS Win Plugin.


The biggest plugin in space...