tranger2_get_rt_disk_by_id()

tranger2_get_rt_disk_by_id()#

Retrieve a real-time disk instance by its identifier. If the specified real-time disk exists, it returns the corresponding JSON object; otherwise, it returns NULL.

Prototype

json_t *tranger2_get_rt_disk_by_id(
    json_t      *tranger,
    const char  *topic_name,
    const char  *rt_id,
    const char  *creator
);

Parameters

Key

Type

Description

tranger

json_t *

Pointer to the TimeRanger database instance.

topic_name

const char *

Name of the topic associated with the real-time disk.

rt_id

const char *

Identifier of the real-time disk to retrieve.

creator

const char *

Creator identifier used to filter the real-time disk instances.

Return Value

Returns a JSON object representing the real-time disk instance if found; otherwise, returns NULL.

Notes

This function does not produce any error messages if the real-time disk is not found.

Prototype

// Not applicable in JS

Prototype

# Not applicable in Python
Examples
// TODO C examples

// TODO JS examples

# TODO Python examples