Main Content

matlab.settings.mustBeIntegerScalar

Validate that setting value is integer array with one element

Description

example

matlab.settings.mustBeIntegerScalar(settingvalue) issues an error if settingvalue is not an integer array with one element. 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

collapse all

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);

Now, test whether the validation function works. 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

collapse all

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

Other data types cause an error.

Introduced in R2019b