HTML rendering created 2025-09-06 byMichael Kerrisk, author ofThe Linux Programming Interface. For details of in-depthLinux/UNIX system programming training courses that I teach, lookhere. Hosting byjambit GmbH. |  |
NAME |SYNOPSIS |DESCRIPTION |RETURN VALUE |NOTES |HISTORY |SEE ALSO |COLOPHON | |
SD_JOURNAL_GET_CURSOR(3) sd_journal_get_cursorSD_JOURNAL_GET_CURSOR(3)sd_journal_get_cursor, sd_journal_test_cursor - Get cursor string for or test cursor string against the current journal entry
#include <systemd/sd-journal.h>int sd_journal_get_cursor(sd_journal *j, char **ret_cursor);int sd_journal_test_cursor(sd_journal *j, const char *cursor);
sd_journal_get_cursor()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 viasd_journal_seek_cursor(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 libcmalloc(3) and should be freed after use withfree(3). Theret_cursor parameter may be passed asNULLin which case the cursor string is not generated, however the return value will indicate whether the journal context is currently positioned on an entry, and thus has a cursor associated.sd_journal_test_cursor()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 ofsd_journal_seek_cursor(3), whether the entry being sought to was actually found in the journal or the next closest entry was used instead. Note thatsd_journal_get_cursor()andsd_journal_test_cursor() will not work beforesd_journal_next(3) (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.
sd_journal_get_cursor()returns 0 on success or a negative errno-style error code.sd_journal_test_cursor()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.Errors Returned errors may indicate the following problems:-EADDRNOTAVAIL The journal context is currently not positioned on any entry, and hence no cursor string can be generated.-EINVAL The journal context parameter isNULL.-ECHILD The journal context object has been allocated in a different process than it is being used in now.
All functions listed here are thread-agnostic and only a single specific thread may operate on a given object during its entire lifetime. It is safe to allocate multiple independent objects and use each from a specific thread in parallel. However, it is 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 do not operate on it at the very same time. Functions described here are available as a shared library, which can be compiled against and linked to with thelibsystemd pkg-config(1) file.
sd_journal_get_cursor()was added in version 187.sd_journal_test_cursor()was added in version 195.
systemd(1),sd-journal(3),sd_journal_open(3),sd_journal_seek_cursor(3)
This page is part of thesystemd (systemd system and service manager) project. Information about the project can be found at ⟨http://www.freedesktop.org/wiki/Software/systemd⟩. If you have a bug report for this manual page, see ⟨http://www.freedesktop.org/wiki/Software/systemd/#bugreports⟩. This page was obtained from the project's upstream Git repository ⟨https://github.com/systemd/systemd.git⟩ on 2025-08-11. (At that time, the date of the most recent commit that was found in the repository was 2025-08-11.) 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 isnot part of the original manual page), send a mail to man-pages@man7.orgsystemd 258~rc2SD_JOURNAL_GET_CURSOR(3)Pages that refer to this page:sd-journal(3), sd_journal_next(3), sd_journal_open(3), sd_journal_seek_head(3), systemd.directives(7), systemd.index(7)
HTML rendering created 2025-09-06 byMichael Kerrisk, author ofThe Linux Programming Interface. For details of in-depthLinux/UNIX system programming training courses that I teach, lookhere. Hosting byjambit GmbH. | |