1 <?xml version='
1.0'
?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 SPDX-License-Identifier: LGPL-2.1+
9 <refentry id=
"sd_journal_get_catalog" xmlns:
xi=
"http://www.w3.org/2001/XInclude">
12 <title>sd_journal_get_catalog
</title>
13 <productname>systemd
</productname>
17 <refentrytitle>sd_journal_get_catalog
</refentrytitle>
18 <manvolnum>3</manvolnum>
22 <refname>sd_journal_get_catalog
</refname>
23 <refname>sd_journal_get_catalog_for_message_id
</refname>
24 <refpurpose>Retrieve message catalog entry
</refpurpose>
29 <funcsynopsisinfo>#include
<systemd/sd-journal.h
></funcsynopsisinfo>
32 <funcdef>int
<function>sd_journal_get_catalog
</function></funcdef>
33 <paramdef>sd_journal *
<parameter>j
</parameter></paramdef>
34 <paramdef>char **
<parameter>ret
</parameter></paramdef>
38 <funcdef>int
<function>sd_journal_get_catalog_for_message_id
</function></funcdef>
39 <paramdef>sd_id128_t
<parameter>id
</parameter></paramdef>
40 <paramdef>char **
<parameter>ret
</parameter></paramdef>
47 <title>Description
</title>
49 <para><function>sd_journal_get_catalog()
</function> retrieves a
50 message catalog entry for the current journal entry. This will
51 look up an entry in the message catalog by using the
52 <literal>MESSAGE_ID=
</literal> field of the current journal entry.
53 Before returning the entry all journal field names in the catalog
54 entry text enclosed in
"@" will be replaced by the respective
55 field values of the current entry. If a field name referenced in
56 the message catalog entry does not exist, in the current journal
57 entry, the
"@" will be removed, but the field name otherwise left
60 <para><function>sd_journal_get_catalog_for_message_id()
</function>
61 works similar to
<function>sd_journal_get_catalog()
</function> but
62 the entry is looked up by the specified message ID (no open
63 journal context is necessary for this), and no field substitution
66 <para>For more information about the journal message catalog
67 please refer to the
<ulink
68 url=
"https://www.freedesktop.org/wiki/Software/systemd/catalog">Journal
69 Message Catalogs
</ulink> documentation page.
</para>
73 <title>Return Value
</title>
75 <para><function>sd_journal_get_catalog()
</function> and
76 <function>sd_journal_get_catalog_for_message_id()
</function>
77 return
0 on success or a negative errno-style error code. If no
78 matching message catalog entry is found, -ENOENT is
81 <para>On successful return,
<parameter>ret
</parameter> points to a
82 new string, which must be freed with
83 <citerefentry project='man-pages'
><refentrytitle>free
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
90 <para>Function
<function>sd_journal_get_catalog()
</function> is thread-agnostic and only a
91 single thread may operate on a given
<structname>sd_journal
</structname> object. Function
92 <function>sd_journal_get_catalog_for_message_id()
</function> is thread-safe.
</para>
94 <xi:include href=
"libsystemd-pkgconfig.xml" xpointer=
"pkgconfig-text"/>
98 <title>See Also
</title>
101 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
102 <citerefentry><refentrytitle>systemd.journal-fields
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
103 <citerefentry><refentrytitle>sd-journal
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
104 <citerefentry><refentrytitle>sd_journal_open
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
105 <citerefentry><refentrytitle>sd_journal_next
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
106 <citerefentry><refentrytitle>sd_journal_get_data
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
107 <citerefentry project='man-pages'
><refentrytitle>malloc
</refentrytitle><manvolnum>3</manvolnum></citerefentry>