Back to Aurora Vision Library website

You are here: Start » Function Reference » All Functions » Process » AvsFilter_Execute_WaitForExit_Deprecated

AvsFilter_Execute_WaitForExit_Deprecated


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: STD.h
Namespace: avs
Module: FoundationLite

Executes a command using the system console and waits for completion.

Syntax

void avs::AvsFilter_Execute_WaitForExit_Deprecated
(
	const atl::File& inCommand,
	const atl::Array<atl::String>& inArguments,
	const atl::Directory& inWorkingDirectory,
	int& outReturnCode,
	atl::String& outResult
)

Parameters

Name Type Default Description
Input value inCommand const File& System command to be executed.
Input value inArguments const Array<String>& Arguments for the command.
Input value inWorkingDirectory const Directory& \".\" Working directory in which the command will be executed.
Output value outReturnCode int& Return code of the executed command.
Output value outResult String& Captured text data.

Description

Filter executes a command provided in inCommand with inArguments arguments. The command will be executed in a directory provided in inWorkingDirectory.

Output outResult contains all the text captured during the execution of command.

Usually value 0 on output outReturnCode means that command was executed correctly.

Program execution is blocked until command execution is finished.

Examples

To get list of files on the C drive, working directory should be set to C:\ and command should be set to dir. On Linux ls command should be used.

Remarks

During the command execution, system console may appear. It could cause loss of the focus on the HMI form.

Usage of this filter is not recommended in AVL.

Errors

If an error occurred during the process execution a value -1 will be returned on outReturnCode.

List of possible exceptions:

Error type Description
DomainError Could not remember current working directory.
DomainError Provided inWorkingDirectory is incorrect or not found. Path: provided working directory
DomainError Provided inWorkingDirectory user provided directory is incorrect or not found.
RuntimeError Could not return from working directory.