kv_create_delete_with_options_op()
#include <kvstore.h>
kv_error_tkv_create_delete_with_options_op(kv_operations_t *list,
const kv_key_t *key,
const kv_version_t *version,kv_return_value_version_enum return_info,
kv_int_t abort_on_failure) Create a complex delete operation suitable for use as part of a multi-step operation to be run using kv_execute(). The semantics of the returned operation when executed are identical to that ofkv_delete_with_options().
Parameters
-
list
The list parameter is the operation sequence to which this delete operation is appended. The sequence is allocated using kv_create_operations().
-
key
The key parameter identifies the Key portion of the record to be deleted.
Note that all of the operations performed under a single call to kv_execute() must share the same major key path, and that major key path must be complete.
-
version
The version parameter indicates the Version that the record must match before it can be deleted. The Version is obtained using the kv_get_version() function.
-
return_info
The return_info parameter indicates what information should be returned to the kv_execute() results list by this operation. See kv_return_value_version_enum for a description of the options accepted by this parameter.
-
abort_on_failure
The abort_on_failure parameter indicates whether the entire operation should abort if this delete operation fails. Specify 1 if you want the operation to abort upon deletion failure.