UpdateAction#

Fully qualified name: carb::dictionary::UpdateAction

Defined in carb/dictionary/IDictionary.h

enum class carb::dictionary::UpdateAction#

Actions that may be returned by carb::dictionary::OnUpdateItemFn.

See also

IDictionary::update() and OnUpdateItemFn for more information.

Values:

enumerator eOverwrite#

The target item should be overwritten by the source item.

This will include all of the children of the target item as well if one of the items is not a dictionary. The children of the overwritten item will not be enumerated or considered after this.

enumerator eKeep#

The target item should be retained, ignoring the source item.

The children of the target item will still be enumerated after this.

enumerator eReplaceSubtree#

The entire subtree should be replaced (dictionary source item only).

This action only differs from eOverwrite when both the target and source items are dictionaries. If neither or only one item is a dictionary, this action behaves identically to eOverwrite. The subtree of this item may still be enumerated for the update operation after this action is returned.