trmsg_get_message()

trmsg_get_message()#

Retrieves a message from the given list by its key. The returned JSON object contains both the active message and its instances.

Prototype

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

Parameters

Key

Type

Description

list

json_t *

The list containing the messages.

key

const char *

The key identifying the message to retrieve.


Return Value

A JSON object containing the active message and its instances. The returned object is not owned by the caller.

Notes

The returned JSON object should not be modified or freed by the caller.

Prototype

// Not applicable in JS

Prototype

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