diff options
| author | Lennart Poettering <lennart@poettering.net> | 2012-07-13 19:00:48 +0200 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2012-07-13 19:00:48 +0200 |
| commit | 4171a6676c74846c9c189f3a92b97bbcd4a11a13 (patch) | |
| tree | 696bcd61f433e1eb8e3fbddcaae07d15dd6e44b2 /man/sd_journal_next.xml | |
| parent | 67c3cf4f9ea35c1f789526b24a4d052d071902c0 (diff) | |
man: document sd_journal_get_data() and friends
Diffstat (limited to 'man/sd_journal_next.xml')
| -rw-r--r-- | man/sd_journal_next.xml | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/man/sd_journal_next.xml b/man/sd_journal_next.xml index f55ee15744..90fcecb107 100644 --- a/man/sd_journal_next.xml +++ b/man/sd_journal_next.xml @@ -47,6 +47,8 @@ <refname>sd_journal_previous</refname> <refname>sd_journal_next_skip</refname> <refname>sd_journal_previous_skip</refname> + <refname>SD_JOURNAL_FOREACH</refname> + <refname>SD_JOURNAL_FOREACH_BACKWARDS</refname> <refpurpose>Advance or set back the read pointer in the journal</refpurpose> </refnamediv> @@ -76,6 +78,15 @@ <paramdef>uint64_t <parameter>skip</parameter></paramdef> </funcprototype> + <funcprototype> + <funcdef><function>SD_JOURNAL_FOREACH</function></funcdef> + <paramdef>sd_journal* <parameter>j</parameter></paramdef> + </funcprototype> + + <funcprototype> + <funcdef><function>SD_JOURNAL_FOREACH_BACKWARDS</function></funcdef> + <paramdef>sd_journal* <parameter>j</parameter></paramdef> + </funcprototype> </funcsynopsis> </refsynopsisdiv> @@ -105,6 +116,13 @@ that the entry then pointing to is later in time than then previous one, or has the same timestamp.</para> + <para>Note that + <citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry> + and related calls will fail unless + <function>sd_journal_next()</function> has been + invoked at least once in order to position the read + pointer on a journal entry.</para> + <para>Note that the <function>SD_JOURNAL_FOREACH()</function> macro may be used as a wrapper around |