mirror of
https://github.com/systemd/systemd.git
synced 2024-12-16 21:53:40 +08:00
142 lines
6.4 KiB
XML
142 lines
6.4 KiB
XML
<?xml version='1.0'?> <!--*-nxml-*-->
|
||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||
|
||
<!--
|
||
This file is part of systemd.
|
||
|
||
Copyright 2012 Lennart Poettering
|
||
|
||
systemd is free software; you can redistribute it and/or modify it
|
||
under the terms of the GNU Lesser General Public License as published by
|
||
the Free Software Foundation; either version 2.1 of the License, or
|
||
(at your option) any later version.
|
||
|
||
systemd is distributed in the hope that it will be useful, but
|
||
WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||
Lesser General Public License for more details.
|
||
|
||
You should have received a copy of the GNU Lesser General Public License
|
||
along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
||
-->
|
||
|
||
<refentry id="sd_journal_get_catalog">
|
||
|
||
<refentryinfo>
|
||
<title>sd_journal_get_catalog</title>
|
||
<productname>systemd</productname>
|
||
|
||
<authorgroup>
|
||
<author>
|
||
<contrib>Developer</contrib>
|
||
<firstname>Lennart</firstname>
|
||
<surname>Poettering</surname>
|
||
<email>lennart@poettering.net</email>
|
||
</author>
|
||
</authorgroup>
|
||
</refentryinfo>
|
||
|
||
<refmeta>
|
||
<refentrytitle>sd_journal_get_catalog</refentrytitle>
|
||
<manvolnum>3</manvolnum>
|
||
</refmeta>
|
||
|
||
<refnamediv>
|
||
<refname>sd_journal_get_catalog</refname>
|
||
<refname>sd_journal_get_catalog_for_message_id</refname>
|
||
<refpurpose>Retrieve message catalog entry</refpurpose>
|
||
</refnamediv>
|
||
|
||
<refsynopsisdiv>
|
||
<funcsynopsis>
|
||
<funcsynopsisinfo>#include <systemd/sd-journal.h></funcsynopsisinfo>
|
||
|
||
<funcprototype>
|
||
<funcdef>int <function>sd_journal_get_catalog</function></funcdef>
|
||
<paramdef>sd_journal* <parameter>j</parameter></paramdef>
|
||
<paramdef>char** <parameter>ret</parameter></paramdef>
|
||
</funcprototype>
|
||
|
||
<funcprototype>
|
||
<funcdef>int <function>sd_journal_get_catalog_for_message_id</function></funcdef>
|
||
<paramdef>sd_id128_t <parameter>id</parameter></paramdef>
|
||
<paramdef>char** <parameter>ret</parameter></paramdef>
|
||
</funcprototype>
|
||
|
||
|
||
</funcsynopsis>
|
||
</refsynopsisdiv>
|
||
|
||
<refsect1>
|
||
<title>Description</title>
|
||
|
||
<para><function>sd_journal_get_catalog()</function>
|
||
retrieves a message catalog entry for the current
|
||
journal entry. This will look up an entry in the
|
||
message catalog by using the
|
||
<literal>MESSAGE_ID=</literal> 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.</para>
|
||
|
||
<para><function>sd_journal_get_catalog_for_message_id()</function>
|
||
works similar to
|
||
<function>sd_journal_get_catalog()</function> 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.</para>
|
||
|
||
<para>For more information about the journal message
|
||
catalog please refer to the <ulink
|
||
url="http://www.freedesktop.org/wiki/Software/systemd/catalog">Journal
|
||
Message Catalogs</ulink> documentation page.</para>
|
||
</refsect1>
|
||
|
||
<refsect1>
|
||
<title>Return Value</title>
|
||
|
||
<para><function>sd_journal_get_catalog()</function>
|
||
and
|
||
<function>sd_journal_get_catalog_for_message_id()</function>
|
||
return 0 on success or a negative errno-style error
|
||
code. If no matching message catalog entry is found,
|
||
-ENOENT is returned.</para>
|
||
|
||
<para>On successful return, <parameter>ret</parameter>
|
||
points to a new string, which must be freed with
|
||
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1>
|
||
<title>Notes</title>
|
||
|
||
<para>The <function>sd_journal_get_catalog()</function> and
|
||
<function>sd_journal_get_catalog_for_message_id()</function>
|
||
interfaces are available as a shared library, which can
|
||
be compiled and linked to with the
|
||
<constant>libsystemd</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||
file.</para>
|
||
</refsect1>
|
||
|
||
<refsect1>
|
||
<title>See Also</title>
|
||
|
||
<para>
|
||
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||
<citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
|
||
<citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||
<citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||
<citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||
<citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||
<citerefentry><refentrytitle>malloc</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||
</para>
|
||
</refsect1>
|
||
|
||
</refentry>
|