hasActiveValue

Determine whether setting has active value set

Since R2024a

Syntax

hasActiveValue(s)

Description

hasActiveValue(s) returns 1 if the setting has an active value set. Otherwise, hasActiveValue returns 0.

Examples

Determine If Setting Has Active Value

Add custom settings group with one setting. Confirm that it has no active value by default.

s = settings;
g = addGroup(s,"mysettingsgroup");
addSetting(g,"OfficeNumber");
hasActiveValue(g.OfficeNumber)

ans =

  logical

   0

Set the personal value for the OfficeNumber setting, which updates the active value.

g.OfficeNumber.PersonalValue = "East205";

Use a conditional statement to confirm that OfficeNumber now has an active value and, if so, return that value.

if ~isempty("g.OfficeNumber") && hasActiveValue(g.OfficeNumber)
  value = g.OfficeNumber.ActiveValue
else
  disp("OfficeNumber has no active value.")
end

value = 

    "East205"

Input Arguments

s — Setting

SettingsGroup object

Setting, specified as a SettingsGroup object. Use the settings function to access the root settings group object and all the available settings in the tree.

Version History

Introduced in R2024a