trmsg_get_active_message()

`trmsg_get_active_message()`#

trmsg_get_active_message() retrieves the active message associated with the specified key from the given list.

C

Prototype

json_t *trmsg_get_active_message(
    json_t      *list,
    const char  *key
);

Parameters

Key	Type	Description
`list`	`json_t *`	A JSON object representing the list of messages.
`key`	`const char *`	The key identifying the message to retrieve.

Return Value

A JSON object representing the active message associated with the given key. The returned object is not owned by the caller.

Notes

The returned JSON object should not be modified or freed by the caller. To modify the data, create a copy before making changes.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python