getStringAt

Fully qualified name: carb::settings::getStringAt

Defined in carb/settings/SettingsUtils.h

inline omni::string carb::settings::getStringAt(

const ISettings *settings,

cpp::string_view path,

size_t index,

cpp::string_view defaultValue = {},

)

Retrieves a string from an array of string-type setting for simplicity.

Equivalent to:

ScopedRead lock(settings);
if (auto value = settings->getStringViewAt(path, index))
    return omni::string(*value);
return cpp::nullopt;

See also

ISettings::getStringValueAt, getString()

Parameters:

• settings – The acquired ISettings interface.

• path – The setting key path to retrieve (must be an array of strings or defaultValue will be returned).

• index – The array index to retrieve.

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

Returns:

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