matlab.buildtool.BuildResult Class

Namespace: matlab.buildtool

Result of running a build

Since R2022b

Description

The matlab.buildtool.BuildResult class provides the result of running a build. The result includes information about whether the build failed as well as the duration of the build. It also includes detailed information about each task that was part of the build.

The build runner instantiates this class. You do not need to create an object of the class directly.

Properties

Failed — Whether build failed

1 | 0

Whether the build failed, returned as a 1 or 0 of data type logical. If the value is 1, then the build failed. Otherwise, it ran without any failures. The build fails if the build runner encounters an uncaught error while setting up or tearing down the build environment, or while running a task.

Attributes:

GetAccess	public
SetAccess	immutable

Duration — Time spent running build

duration scalar

Time spent running the build, returned as a duration scalar. The total run time for a build exceeds the sum of the times spent running individual tasks because it also accounts for overhead associated with the build runner.

Attributes:

GetAccess	public
SetAccess	immutable

Data Types: duration

TaskResults — Results of tasks

row vector of matlab.buildtool.TaskResult objects

Results of the tasks, returned as a row vector of matlab.buildtool.TaskResult objects. Each TaskResult object includes detailed information about a task that was part of the build.

Attributes:

GetAccess	public
SetAccess	immutable

Version History

Introduced in R2022b