Learn more about Parallel Computing Toolbox

CaptureCommandWindowOutput - Specify whether to return Command Window output

Description

CaptureCommandWindowOutput specifies whether to return command window output for the evaluation of a task object's Function property.

If CaptureCommandWindowOutput is set true (or logical 1), the command window output will be stored in the CommandWindowOutput property of the task object. If the value is set false (or logical 0), the task does not retain command window output.

Characteristics

Usage	Task object
Read-only	While task is running or finished
Data type	Logical

Values

The value of CaptureCommandWindowOutput can be set to true (or logical 1) or false (or logical 0). When you perform get on the property, the value returned is logical 1 or logical 0. The default value is logical 0 to save network bandwidth in situations where the output is not needed; except for batch jobs, whose default is 1 (true).

Examples

Set all tasks in a job to retain any command window output generated during task evaluation.

jm = findResource('scheduler','type','jobmanager', ...
          'name','MyJobManager','LookupURL','JobMgrHost');
j = createJob(jm);
createTask(j, @myfun, 1, {x});
createTask(j, @myfun, 1, {x});
.
.
.
alltasks = get(j, 'Tasks');
set(alltasks, 'CaptureCommandWindowOutput', true)

CaptureCommandWindowOutput - Specify whether to return Command Window output

Description

Characteristics

Values

Examples

See Also

Properties

Recommended Products