Main Content

sltest.testmanager.getpref

Get Test Manager preferences

collapse all in page

Syntax

settings = sltest.testmanager.getpref(group)
settings = sltest.testmanager.getpref(group,preferences)

Description

settings = sltest.testmanager.getpref(group) returns Test Manager preference settings for a group.

settings = sltest.testmanager.getpref(group,preferences) returns Test Manager preferences for one or more group preferences.

Examples

collapse all

Get the preferences for the sections that appear in test suites.

Get preferences for test suite display. A value of 1 means the section appears. 

settings = sltest.testmanager.getpref('TestSuiteDisplay')

settings = 
  struct with fields:

        TestTag: 1
    Description: 1
    Requirement: 1
       Callback: 1
       Coverage: 1

Get the settings for Description and Requirement preferences.

settings = sltest.testmanager.getpref('TestSuiteDisplay',{'Description','Requirement'})

settings = 
  struct with fields:

    Description: 1
    Requirement: 1

Get a list of MATLAB® releases available in Test Manager.

Get the list of MATLAB release preferences.

settings = sltest.testmanager.getpref('MATLABReleases')
ans = 
  1×2 struct array with fields:

    Name
    MATLABRoot
    IsDefault
    Selected

Get the Name value.

settings.Name
ans =
    '14a'
ans =
    'R2017b'

Show the current setting of ShowSimulationLogs IncludeOnCommandPrompt. The value 0 indicates that displaying logs is turned off, and the value 1 indicates it is turned on.

settings = sltest.testmanager.getpref...
    ('ShowSimulationLogs','IncludeOnCommandPrompt')
ans =
  logical

   1

Input Arguments

collapse all

Preference group name, specified as one of these values:

  • 'TestFileDisplay' — File preferences and their display status

  • 'TestSuiteDisplay' — Test suite preferences and their display status

  • 'TestCaseDisplay' — Test case preferences and their display status

  • 'MATLABReleases' — Releases available for testing

  • 'ShowSimulationLogs' — Whether to show simulation logs at the command prompt

  • 'ResultSetProperty' — Name to use for the result set

Preference name, specified as a character vector or a cell array of character vectors. Use settings = sltest.testmanager.getpref(group) to get valid preferences for each group.

Example: ('TestSuiteDisplay','Description')

Example: ('ResultSetProperty','ResultSetName')

Output Arguments

collapse all

Preference settings, returned as a struct.

Version History

Introduced in R2017a

See Also

Topics