getString

Fully qualified name: carb::settings::getString

Defined in carb/settings/SettingsUtils.h

inline omni::string carb::settings::getString(

const ISettings *settings,

cpp::string_view path,

cpp::string_view defaultValue = {},

)

Retrieves a string from a string-type setting for simplicity.

Equivalent to:

ScopedRead lock(settings);
auto value = settings->getStringView(path);
return value ? omni::string(*value) : omni::string(defaultValue);

See also

ISettings::getStringValue, getStringAt()

Parameters:

• settings – The acquired ISettings interface.

• path – The setting key path to retrieve (must be a string or defaultValue will be returned).

• defaultValue – The default value returned if path is not a valid string path.

Returns:

A string object that either contains the string value at path or defaultValue.