tranger2_list_keys()

tranger2_list_keys()#

Returns a list of keys from the specified topic in the TimeRanger database. The function allows filtering keys using a regular expression.

Prototype

json_t *tranger2_list_keys(
    json_t      *tranger,
    const char  *topic_name,
    const char  *rkey
);

Parameters

Key

Type

Description

tranger

json_t *

A pointer to the TimeRanger database instance.

topic_name

const char *

The name of the topic from which to retrieve the keys.

rkey

const char *

A regular expression pattern to filter the keys. If NULL, all keys are returned.


Return Value

A JSON array containing the list of keys. The caller owns the returned JSON object and must free it when no longer needed.

Notes

If the topic does not exist or an error occurs, the function may return NULL.

Prototype

// Not applicable in JS

Prototype

# Not applicable in Python
Examples
// TODO C examples
// TODO JS examples
# TODO Python examples