tranger2_get_iterator_by_id()

tranger2_get_iterator_by_id()#

Retrieve an iterator by its identifier. If the iterator exists, it is returned; otherwise, NULL is returned.

Prototype

json_t *tranger2_get_iterator_by_id(
    json_t      *tranger,
    const char  *topic_name,
    const char  *iterator_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 iterator.

iterator_id

const char *

Unique identifier of the iterator to retrieve.

creator

const char *

Identifier of the entity that created the iterator.

Return Value

Returns a pointer to the iterator JSON object if found; otherwise, returns NULL.

Notes

This function does not produce any error messages if the iterator is not found.

Prototype

// Not applicable in JS

Prototype

# Not applicable in Python
Examples
// TODO C examples

// TODO JS examples

# TODO Python examples