Error

Functions
const char *	kv_get_last_error (const kv_store_t *store)
const char *	kv_get_open_error ()
void	kv_set_debug_output (kv_output_func func)

Detailed Description

This chapter contains functions used to investigate and examine error returns obtained from the C API functions described in this manual.

Most methods in this library return an enumeration, kv_error_t, indicating success or failure. Because of the need to also return integer and "boolean-like" values in some cases, all actual error values are negative. 0 (KV_SUCCESS) indicates no error. Valid integer return values are non-negative. When an error is returned the kv_get_last_error() method may have additional information about the error.

Function Documentation

const char* kv_get_last_error

(

const kv_store_t *

store

)

Returns a string explaining the last error. This string is only useful immediately following an error return; otherwise it may indicate an older, irrelevant error. This value is maintained per-thread and is not valid across threads.

Parameters

[in]

store

The store handle

const char* kv_get_open_error

(

)

Returns a descriptive string of any error that was encountered opening the store.

Returns

the error string.

void kv_set_debug_output

(

kv_output_func

func

)

Sets the thrift logger function which is used to output the debug information from thrift library. By default, the debug output is disabled.

Parameters

[in]

func

The output function