tranger2_get_rt_mem_by_id()

tranger2_get_rt_mem_by_id()#

Retrieve a real-time memory instance by its identifier. If the specified real-time memory instance exists, it is returned; otherwise, NULL is returned.

Prototype

json_t *tranger2_get_rt_mem_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 memory instance.

rt_id

const char *

Identifier of the real-time memory instance to retrieve.

creator

const char *

Creator identifier used to filter the real-time memory instance.

Return Value

Returns a pointer to the real-time memory instance as a json_t * if found, otherwise returns NULL.

Notes

This function does not produce any internal logging or error messages if the requested real-time memory instance is not found.

Prototype

// Not applicable in JS

Prototype

# Not applicable in Python
Examples
// TODO C examples

// TODO JS examples

# TODO Python examples