#include <kvstore.h> kv_error_t kv_delete(kv_store_t *store, const kv_key_t *key)
Delete the key/value pair associated with the key.
Deleting a key/value pair with this method does not automatically delete its children or descendant key/value pairs. To delete children or descendants, use kv_multi_delete() instead.
This function uses the default durability and default request timeout. Default durabilities are set using kv_config_set_durability(). The default request timeout is set using kv_config_set_timeouts().
Possible outcomes when calling this method are:
The KV pair was deleted and the number of records deleted
is returned. For this function, a successful return value
will always be 0
or 1
.
The KV pair was not guaranteed to be deleted successfully. A non-success kv_error_t error is returned; that is, a negative integer is returned.
The store parameter is the handle to the store in which you want to perform the delete operation.