Documentation Home Page RT-LAB Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

StartExecutable

Group

Utilities

Description

Start executable as an external process on the host computer. The function returns immediately, and the outputs are available by calling the function WaitExecutable.

When the option OP_EXEC_FILE_OUTPUT_STDERR is setted, the stderr outputs are separated of the stdout outputs. See WaitExecutable for more information.

When the option OP_EXEC_FILE_DETACHED is setted, the outputs are lost.

Required Control

None

Usage

processId = RtlabApi.StartExecutable(executable, arguments, options)

Input

  • executable: Path and file name of the executable.

  • arguments: Arguments of the executable.

  • options: Options to start executable. See OP_START_EXEC_DEFINE.

Output

  • processId: Process id of the executable.

Exception

  • EOK: Success.

  • OP_EXEC_FILE_START_ALREADY: An executable, which you are waiting for results, is still running.

  • OP_API_START_EXEC_FILE: Error starting the execution of the file.

Examples

None

Related Items

StopExecutable, WaitExecutable, OP_START_EXEC_DEFINE.

Modules

import RtlabApi

OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323