matlab.settings.mustBeIntegerScalar

Validate that setting value is an integer scalar

Syntax

matlab.settings.mustBeIntegerScalar(settingvalue)

Description

matlab.settings.mustBeIntegerScalar(settingvalue) issues an error if settingvalue is not an integer scalar. This function does not return a value.

This function ignores input arguments that are empty values. Therefore, no error is thrown when the setting value is empty.

Examples

Validate That Setting Value Is an Integer Scalar

Create a setting and specify a function to validate that the setting value is an integer scalar.

Create the settings group mysettings.

s = settings;
addGroup(s,'mysettings');

Add the setting MyIntegerSetting to mysettings and specify the validation function matlab.settings.mustBeIntegerScalar.

addSetting(s.mysettings,'MyIntegerSetting','ValidationFcn',@matlab.settings.mustBeIntegerScalar);

Test the validation function. Set the value of MyIntegerSetting to a noninteger value. As expected, MATLAB^® throws an error.

s.mysettings.MyIntegerSetting.PersonalValue = 'Hello';

Error setting 'MyIntegerSetting' in group 'mysettings': Value must be integer.

Input Arguments

settingvalue — Setting value to validate

scalar

Setting value to validate, specified as a scalar of one of the following:

• logical, char, or numeric class

• MATLAB classes that implement either isnumeric or islogical and isscalar, isreal, isfinite, floor, and eq.

Other data types cause an error.

Version History

Introduced in R2019b