getOptions

Class: sltest.testmanager.TestFile
Package: sltest.testmanager

Get and set test file options

Syntax

opt = getOptions(tf)


Description

opt = getOptions(tf) returns the test file options object sltest.testmanager.Options associated with the test file tf.

Input Arguments

tf — Test file

sltest.testmanager.TestFile object

Test file whose options to get, specified as an sltest.testmanager.TestFile object.

Output Arguments

opt — Test file options

sltest.testmanager.Options object

Test file options, returned as an sltest.testmanager.Options object.

Examples

Get and Set Test File Options

% Create the test file, test suite, and test case structure
tf = sltest.testmanager.TestFile('API Test File');
ts = createTestSuite(tf,'API Test Suite');
tc = createTestCase(ts,'baseline','Baseline API Test Case');

% Get the test file options
opt = getOptions(tf);

% Set the title for the report and specify to save figures
opt.Title = 'ABC Co. Test Results';
opt.SaveFigures = true;

Version History

Introduced in R2017a