matlab.settings.mustBeLogicalScalar

Validate that setting value is a logical scalar

Syntax

matlab.settings.mustBeLogicalScalar(settingvalue)

matlab.settings.mustBeLogicalScalar(settingvalue) issues an error if settingvalue is not a logical 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.

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

Create the settings group mysettings.

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

Add the setting MyLogicalSetting to mysettings and specify the validation function matlab.settings.mustBeLogicalScalar.

addSetting(s.mysettings,'MyLogicalSetting','ValidationFcn',@matlab.settings.mustBeLogicalScalar);

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

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

Error setting 'MyLogicalSetting' in group 'mysettings': Value must be logical.

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

Other data types cause an error.

Introduced in R2019b