tranger2_write_user_flag()

tranger2_write_user_flag()#

The tranger2_write_user_flag() function updates the user flag of a specific record identified by rowid in the given topic_name within the TimeRanger database.

Prototype

int tranger2_write_user_flag(
    json_t      *tranger,
    const char  *topic_name,
    uint64_t     rowid,
    uint32_t     user_flag
);

Parameters

Key

Type

Description

tranger

json_t *

A pointer to the TimeRanger database instance.

topic_name

const char *

The name of the topic containing the record.

rowid

uint64_t

The unique row identifier of the record to update.

user_flag

uint32_t

The new user flag value to be assigned to the record.


Return Value

Returns 0 on success, or a negative value on failure.

Notes

This function modifies the user flag of an existing record but does not alter other record attributes. Use tranger2_set_user_flag() if you need to update the flag using a mask.

Prototype

// Not applicable in JS

Prototype

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