tranger2_read_user_flag()

tranger2_read_user_flag()#

The tranger2_read_user_flag() function retrieves the user flag associated with a specific record in a given topic.

Prototype

uint16_t tranger2_read_user_flag(
    json_t  *tranger,
    const char *topic_name,
    uint64_t rowid
);

Parameters

Key

Type

Description

tranger

json_t *

Pointer to the TimeRanger database instance.

topic_name

const char *

Name of the topic containing the record.

rowid

uint64_t

Unique identifier of the record whose user flag is to be retrieved.


Return Value

Returns the uint16_t user flag associated with the specified record.

Notes

The function is used in writing mode to check the user flag of a record before modifying it.

Prototype

// Not applicable in JS

Prototype

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