Debian Codegraph @

upstream/debian-trixie/man3/sd_journal_get_cursor.3

raw
1 '\" t
2 .TH "SD_JOURNAL_GET_CURSOR" "3" "" "systemd 257.13" "sd_journal_get_cursor"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 sd_journal_get_cursor, sd_journal_test_cursor \- Get cursor string for or test cursor string against the current journal entry
24 .SH "SYNOPSIS"
25 .sp
26 .ft B
27 .nf
28 #include <systemd/sd\-journal\&.h>
29 .fi
30 .ft
31 .HP \w'int\ sd_journal_get_cursor('u
32 .BI "int sd_journal_get_cursor(sd_journal\ *" "j" ", char\ **" "cursor" ");"
33 .HP \w'int\ sd_journal_test_cursor('u
34 .BI "int sd_journal_test_cursor(sd_journal\ *" "j" ", const\ char\ *" "cursor" ");"
35 .SH "DESCRIPTION"
36 .PP
37 \fBsd_journal_get_cursor()\fR
38 returns a cursor string for the current journal entry\&. A cursor is a serialization of the current journal position formatted as text\&. The string only contains printable characters and can be passed around in text form\&. The cursor identifies a journal entry globally and in a stable way and may be used to later seek to it via
39 \fBsd_journal_seek_cursor\fR(3)\&. The cursor string should be considered opaque and not be parsed by clients\&. Seeking to a cursor position without the specific entry being available locally will seek to the next closest (in terms of time) available entry\&. The call takes two arguments: a journal context object and a pointer to a string pointer where the cursor string will be placed\&. The string is allocated via libc
40 \fBmalloc\fR(3)
41 and should be freed after use with
42 \fBfree\fR(3)\&.
43 .PP
44 \fBsd_journal_test_cursor()\fR
45 may be used to check whether the current position in the journal matches the specified cursor\&. This is useful since cursor strings do not uniquely identify an entry: the same entry might be referred to by multiple different cursor strings, and hence string comparing cursors is not possible\&. Use this call to verify after an invocation of
46 \fBsd_journal_seek_cursor\fR(3), whether the entry being sought to was actually found in the journal or the next closest entry was used instead\&.
47 .PP
48 Note that
49 \fBsd_journal_get_cursor()\fR
50 and
51 \fBsd_journal_test_cursor()\fR
52 will not work before
53 \fBsd_journal_next\fR(3)
54 (or one of the other functions which move to an entry) has been called at least once to position the read pointer at a valid entry\&.
55 .SH "RETURN VALUE"
56 .PP
57 \fBsd_journal_get_cursor()\fR
58 returns 0 on success or a negative errno\-style error code\&.
59 \fBsd_journal_test_cursor()\fR
60 returns positive if the current entry matches the specified cursor, 0 if it does not match the specified cursor or a negative errno\-style error code on failure\&.
61 .SH "NOTES"
62 .PP
63 All functions listed here are thread\-agnostic and only a single thread may operate on a given object at any given time\&. Different threads may access the same object at different times\&. Multiple independent objects may be used from different threads in parallel\&.
64 .PP
65 Functions described here are available as a shared library, which can be compiled against and linked to with the
66 \fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
67 file\&.
68 .SH "HISTORY"
69 .PP
70 \fBsd_journal_get_cursor()\fR
71 was added in version 187\&.
72 .PP
73 \fBsd_journal_test_cursor()\fR
74 was added in version 195\&.
75 .SH "SEE ALSO"
76 .PP
77 \fBsystemd\fR(1), \fBsd-journal\fR(3), \fBsd_journal_open\fR(3), \fBsd_journal_seek_cursor\fR(3)