Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Group

Utilities

Description

Waits

Wait for outputs generated by an executable. Call this function until the executable have finished (when status = 1).

When the executable was started with the option OP_EXEC_FILE_OUTPUT_STDERR setted the stdout and stderr buffer are output in two different buffer.

Required Control

None

Usage

(displayBuffer, errorBuffer, status) = RtlabApi.WaitExecutable (timeout)

Input

  • timeOut: Timeout in milliseconds to wait for results.

  • fbElement: Functional block element which control is to be requested. This input is used to specify the acquisition groups or the subsystem id when the function block are OP_FB_ACQ_GROUP and OP_FB_SIGNAL respectively. Normally, this value is 0.

  • priority: Control priority to be requested. Higher is the value, higher is the priority. See OP_CONTROL_PRIORITY.

Output

  • displayBuffer: Stdout outputs of the executable. When the executable wasn't started with OP_EXEC_FILE_OUTPUT_STDERR(2) option, this buffer also contains the stderr outputs.

  • errorBuffer: Stderr output of the executable when the executable was started with the OP_EXEC_FILE_OUTPUT_STDERR(2). Otherwise, the string is empty.

  • status: Status of the execution. True(1) when executable has finished, otherwise False(0).

Exception

  • EOK: Success.

  • OP_API_WAIT_EXEC_FILE: Error receiving results from the executable.

Examples

None

Related Items

StartExecutable, StopExecutable.

Modules

import RtlabApi