getStringFromItemValue

Fully qualified name: carb::settings::getStringFromItemValue

Defined in carb/settings/SettingsUtils.h

template<typename StringT = omni::string>
StringT carb::settings::getStringFromItemValue(

const ISettings *settings,

cpp::string_view path,

cpp::string_view defaultValue = {},

)

Retrieves a string from a setting key for simplicity.

Typically to retrieve a string value from dictionary::Item,

See also

ISettings::createStringFromItemValue(), getStringFromItemValueAt().

Template Parameters:

StringT – The string type to return. Must be constructible from cpp::string_view. Defaults to omni::string.

Parameters:

• settings – The acquired ISettings interface.

• path – The setting key path to retrieve.

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

Returns:

A string representation of the item value, or defaultValue.