ShellExecute (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Use in service mode
Operating mode in GO mode and at runtime
Required application feature
Running an APK file setup
Application in the background: Android 10 specific case

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ShellExecute (Function)

In french: LanceAppliAssociée

Opens a document in its associated application. The application is opened first, then the specified document.

Remarks:

The application used to open the document is the one associated with the extension of the document in Windows (INI file or registry). This associated application may differ according to the configurations used.
This document is opened on the server. This function can be used on the development computer because this compute is considered as being the server.
This document must be found on the server or at any Internet address. This document is opened on the computer of the Web user.
The application used to open the document is the application corresponding to the MIME type associated with the file extension. If several applications correspond to the same type of file, a dialog box will be displayed to select the application to start.
ShellExecute is a locking function: the application will continue to run when closing the document and its associated application. The document must be on the computer.
To display any page in a browser, you can also use BrowserRunApp.

Versions 16 and later

This function is now available for Android applications.

New in version 16

This function is now available for Android applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available for iPhone/iPad applications.

New in version 18

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available for iPhone/iPad applications.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available for iPhone/iPad applications.

Versions 19 and later

This function is now available for Java applications.

New in version 19

This function is now available for Java applications.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

// Open the "Functions.doc" document in Word
ShellExecute("C:\WDNEWS\Version\Functions.doc")
// Print the document
ShellExecute("C:\WDNEWS\Version\Functions.doc", "print")

// Open the "Functions.psw" document in Word
ShellExecute("\WDNEWS\Version\Functions.psw")

// Open a site in the default browser
ShellExecute("http://www.windev.com")

// Start the default messaging
ShellExecute("mailto:pcsoft@windev.com")
// Start the messaging with parameters
// Parameters recognized by Outlook
ShellExecute("mailto:pcsoft@windev.com" + ...
"?subject=Subject: LST &body=Text: the summary of the LST")

// Open the "Invoice.doc" document from its shortcut
ShellExecute("""C:\Documents and Settings\Julia\Desktop\Shortcut to Invoice.doc.lnk""")

// Open a site in the current browser
ShellExecute("http://www.windev.com")

Syntax

<Result> = ShellExecute(<File name> [, <Verb>])

<Result>: Boolean

True if the document was opened,
False otherwise.
This parameter is not available. This function returns no result.
Returns False if the application is run with a Java virtual machine (JRE) earlier than version 1.6.

<File name>: Character string (with quotes)

Name and full (or relative) path of document to open. A UNC path can be used.
If space characters are found in the name or path of the document to open, the quotes found around this parameter must be tripled.
This parameter can also correspond to a Windows shortcut.
No relative path or UNC path can be used.
Versions 16 and later
This parameter can correspond to a full path, to a relative path or to a URI.
For example:
"/sdcard/photo.png"
"/sdcard/video.3gp".
"http://www.windev.com": starts the Web browser on the specified page.
"geo:1.44951,43.604363": starts Google Maps or equivalent.
"mailto:pcsoft@pcsoft.fr" starts the application for sending emails.
"sms:0612345678": starts the application for sending SMSs.
The files found in the application directory (or in one of its sub-directories) are not accessible by most of the external applications. We recommend that you use ShellExecute with files found on the external memory of the device (for example: sdcard) because they are accessible from all the applications.
New in version 16
This parameter can correspond to a full path, to a relative path or to a URI.
For example:
"/sdcard/photo.png"
"/sdcard/video.3gp".
"http://www.windev.com": starts the Web browser on the specified page.
"geo:1.44951,43.604363": starts Google Maps or equivalent.
"mailto:pcsoft@pcsoft.fr" starts the application for sending emails.
"sms:0612345678": starts the application for sending SMSs.
The files found in the application directory (or in one of its sub-directories) are not accessible by most of the external applications. We recommend that you use ShellExecute with files found on the external memory of the device (for example: sdcard) because they are accessible from all the applications.
This parameter can correspond to a full path, to a relative path or to a URI.
For example:
"/sdcard/photo.png"
"/sdcard/video.3gp".
"http://www.windev.com": starts the Web browser on the specified page.
"geo:1.44951,43.604363": starts Google Maps or equivalent.
"mailto:pcsoft@pcsoft.fr" starts the application for sending emails.
"sms:0612345678": starts the application for sending SMSs.
The files found in the application directory (or in one of its sub-directories) are not accessible by most of the external applications. We recommend that you use ShellExecute with files found on the external memory of the device (for example: sdcard) because they are accessible from all the applications.
Versions 18 and later
Only the files found in the "appdata" directory can be handled. No Internet URL can be specified.
New in version 18
Only the files found in the "appdata" directory can be handled. No Internet URL can be specified.
Only the files found in the "appdata" directory can be handled. No Internet URL can be specified.

<Verb>: Optional character string (with quotes)

Verb that must be used to start the document. The verbs are defined for each application, to indicate the actions that can be performed. The most common verbs are open or print. If this parameter is not specified, the verb used will be the default verb for the type of document.
This parameter is not available.

Versions 16 and later
This parameter is not available.
This parameter is not available.
New in version 16
This parameter is not available.
This parameter is not available.
This parameter is not available.
This parameter is not available.

Remarks

Use in service mode

ShellExecute used in service mode is used to run the associated application but the interface of this application is not visible.

Operating mode in GO mode and at runtime

In GO mode (simulation on the development computer), the application to start must be found on the development computer.

At run time, the application to start must be found on the Pocket PC.

The differences between GO mode (simulator) and real use are presented in Differences between GO mode and real use.

Versions 21 and later

Required application feature

The use of this function triggers the declaration of one application feature in the application generation wizard.

Required feature: Family and corporate networks

This feature allows the applications to use incoming and outgoing accesses to the family and corporate networks.

New in version 21

Required application feature

The use of this function triggers the declaration of one application feature in the application generation wizard.

Required feature: Family and corporate networks

This feature allows the applications to use incoming and outgoing accesses to the family and corporate networks.

Required application feature

The use of this function triggers the declaration of one application feature in the application generation wizard.

Required feature: Family and corporate networks

This feature allows the applications to use incoming and outgoing accesses to the family and corporate networks.

Versions 24 and later

Running an APK file setup

From Android 8, to run the setup of an APK file with ShellExecute, it is necessary to modify the permissions required by the application.

Required permission: REQUEST_INSTALL_PACKAGES.

This permission is used to install packages.

For more details (especially for previous versions of WINDEV Mobile), see FAQ 16927: What to do on Android 8 if the setup of an APK file with ShellExecute is no longer allowed?.

New in version 24

Running an APK file setup

From Android 8, to run the setup of an APK file with ShellExecute, it is necessary to modify the permissions required by the application.

Required permission: REQUEST_INSTALL_PACKAGES.

This permission is used to install packages.

For more details (especially for previous versions of WINDEV Mobile), see FAQ 16927: What to do on Android 8 if the setup of an APK file with ShellExecute is no longer allowed?.

Running an APK file setup

From Android 8, to run the setup of an APK file with ShellExecute, it is necessary to modify the permissions required by the application.

Required permission: REQUEST_INSTALL_PACKAGES.

This permission is used to install packages.

For more details (especially for previous versions of WINDEV Mobile), see FAQ 16927: What to do on Android 8 if the setup of an APK file with ShellExecute is no longer allowed?.

Versions 25 and later

Application in the background: Android 10 specific case

From Android 10, it is no longer possible to open a window when the application is in the background.

ShellExecute can open a window. If this function is used while the application is in the background, a fatal error will occur.

Tips:

It is possible to determine if the application is in the background using InBackgroundMode.
If an application needs to interact with the user while it is in the background, the solution is to display a notification (via the Notification type). When the notification is clicked on, the application will be brought back to the foreground if ..ActivateApplication is set to True. It is also possible to open a window from the procedure passed to ..ActionClick.

See Android 10: Behavior of applications in the background for more details.

New in version 25

Application in the background: Android 10 specific case

From Android 10, it is no longer possible to open a window when the application is in the background.

ShellExecute can open a window. If this function is used while the application is in the background, a fatal error will occur.

Tips:

It is possible to determine if the application is in the background using InBackgroundMode.
If an application needs to interact with the user while it is in the background, the solution is to display a notification (via the Notification type). When the notification is clicked on, the application will be brought back to the foreground if ..ActivateApplication is set to True. It is also possible to open a window from the procedure passed to ..ActionClick.

See Android 10: Behavior of applications in the background for more details.

Application in the background: Android 10 specific case

From Android 10, it is no longer possible to open a window when the application is in the background.

ShellExecute can open a window. If this function is used while the application is in the background, a fatal error will occur.

Tips:

It is possible to determine if the application is in the background using InBackgroundMode.
If an application needs to interact with the user while it is in the background, the solution is to display a notification (via the Notification type). When the notification is clicked on, the application will be brought back to the foreground if ..ActivateApplication is set to True. It is also possible to open a window from the procedure passed to ..ActionClick.

See Android 10: Behavior of applications in the background for more details.

Business / UI classification : Neutral code

Component : wd260std.dll