sd_journal_get_catalog(3) — Linux manual page


SD_JOURNA...T_CATALOG(3) sd_journal_get_catalog SD_JOURNA...T_CATALOG(3)

NAME         top

       sd_journal_get_catalog, sd_journal_get_catalog_for_message_id -
       Retrieve message catalog entry

SYNOPSIS         top

       #include <systemd/sd-journal.h>

       int sd_journal_get_catalog(sd_journal *j, char **ret);

       int sd_journal_get_catalog_for_message_id(sd_id128_t id,
                                                 char **ret);

DESCRIPTION         top

       sd_journal_get_catalog() retrieves a message catalog entry for
       the current journal entry. This will look up an entry in the
       message catalog by using the "MESSAGE_ID=" field of the current
       journal entry. Before returning the entry all journal field names
       in the catalog entry text enclosed in "@" will be replaced by the
       respective field values of the current entry. If a field name
       referenced in the message catalog entry does not exist, in the
       current journal entry, the "@" will be removed, but the field
       name otherwise left untouched.

       sd_journal_get_catalog_for_message_id() works similar to
       sd_journal_get_catalog() but the entry is looked up by the
       specified message ID (no open journal context is necessary for
       this), and no field substitution is performed.

       For more information about the journal message catalog please
       refer to the Journal Message Catalogs[1] documentation page.

RETURN VALUE         top

       sd_journal_get_catalog() and
       sd_journal_get_catalog_for_message_id() return 0 on success or a
       negative errno-style error code. If no matching message catalog
       entry is found, -ENOENT is returned.

       On successful return, ret points to a new string, which must be
       freed with free(3).

NOTES         top

       Function sd_journal_get_catalog() is thread-agnostic and only a
       single specific thread may operate on a given object during its
       entire lifetime. It's safe to allocate multiple independent
       objects and use each from a specific thread in parallel. However,
       it's not safe to allocate such an object in one thread, and
       operate or free it from any other, even if locking is used to
       ensure these threads don't operate on it at the very same time.

       Function sd_journal_get_catalog_for_message_id() is are
       thread-safe and may be called in parallel from multiple threads.

       Functions described here are available as a shared library, which
       can be compiled against and linked to with the
       libsystemd pkg-config(1) file.

HISTORY         top

       sd_journal_get_catalog() and
       sd_journal_get_catalog_for_message_id() were added in version

SEE ALSO         top

       systemd(1), systemd.journal-fields(7), sd-journal(3),
       sd_journal_open(3), sd_journal_next(3), sd_journal_get_data(3),

NOTES         top

        1. Journal Message Catalogs

COLOPHON         top

       This page is part of the systemd (systemd system and service
       manager) project.  Information about the project can be found at
       ⟨⟩.  If you have
       a bug report for this manual page, see
       This page was obtained from the project's upstream Git repository
       ⟨⟩ on 2024-06-14.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2024-06-13.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to

systemd 257~devel                               SD_JOURNA...T_CATALOG(3)

Pages that refer to this page: sd-journal(3)systemd.directives(7)systemd.index(7)