endurox.ndrxpy_ubfdict_delonset

endurox.ndrxpy_ubfdict_delonset(delonset: bool) → bool

Configure UbfDict API to zap existing field value, when setting unspecified field occurrence. Default value is False, meaning that if setting the unspecified field with single value or list of values, existing occurrences are changed, however if there is some greater occurrence for the field in the buffer, those values for performance reasons are left intact. If setting is set as True, then API will check and delete all field occurrences, prior setting the value/s.

Setting stored in thread-local-storage, meaning that different threads might use different settings.

This flag configures only the UbfDict based field access. This does not affect field access done at UbfDictFld object level,

Parameters:

do_use (bool) – If set to True, UbfDict field setting routine will ensure that all occurrences of the value is removed prior setting new value. If set to False (which is default), new fields overwrites matching occurrences, but existing occurrences are left intact.

Returns:

prev – Previous setting

Return type:

bool