tranger2_topic_desc()

`tranger2_topic_desc()`#

tranger2_topic_desc() retrieves the description of a specified topic from the TimeRanger database.

C

Prototype

json_t *tranger2_topic_desc(
    json_t *tranger,
    const char *topic_name
);

Parameters

Key	Type	Description
`tranger`	`json_t *`	A reference to the TimeRanger database instance.
`topic_name`	`const char *`	The name of the topic whose description is to be retrieved.

Return Value

A JSON object containing the topic description. The caller must decrement the reference count of the returned JSON object.

Notes

The returned JSON object must be properly decremented using json_decref() to avoid memory leaks.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python