StartTask
- Last UpdatedOct 29, 2026
- 1 minute read
StartTask is a built-in function that starts a specified execution task or runtime module.
|
Function |
Group |
Execution |
String Exp. |
Windows |
Windows Embedded |
IoT View |
Thin Clients |
Mobile Access |
|---|---|---|---|---|---|---|---|---|
|
StartTask |
Module Activity |
Asynchronous |
No |
Supported |
Supported |
Not supported |
Executed on Server |
Executed on Server |
Syntax
StartTask(strTask)
StartTask ( { strTask | " { BGTask | Core | DBSpy | XDB | Driver | LogWin | MobileAccess | OPCClient | OPCUAClient | OPCUAServer | OPCServer | TCPClient | TCPServer | Viewer } " } )
strTask
The name of the task or module to start (must be one of the following):
|
Value |
Description |
|---|---|
|
BGTask |
Background Task |
|
Core |
Core Runtime |
|
DBSpy |
Watch |
|
XDB |
Database/ERP |
|
Driver |
Communication Driver (for all drivers; see Notes below) |
|
LogWin |
LogWin |
|
MobileAccess |
Mobile Access |
|
OPCUAClient |
OPC UA Client |
|
OPCUAServer |
OPC UA Server |
|
OPCServer |
OPC DA Server |
|
TCPClient |
TCP/IP Client |
|
TCPServer |
TCP/IP Server |
|
Viewer |
Viewer |
For more information, see Runtime Tasks.
Return value
This function returns one of the following possible values:
|
Value |
Description |
|---|---|
|
0 |
Failure |
|
1 |
Success |
Notes
If you use this function to start the Driver Runtime (for example, StartTask("Driver")), it starts all of the drivers that are configured in your project. To start a specific driver, use the Exec function instead.
Examples
Start the Viewer module, which is used to view the local project runtime:
StartTask("Viewer")