sd_varlink_set_description(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | HISTORY | SEE ALSO | COLOPHON

SD_VARLI...CRIPTION(3)  sd_varlink_set_description SD_VARLI...CRIPTION(3)

NAME         top

       sd_varlink_set_description, sd_varlink_get_description - Set or
       query description of a Varlink connection object

SYNOPSIS         top

       #include <systemd/sd-link.h>

       int sd_varlink_set_description(sd_varlink *link,
                                      const char *description);

       const char* sd_varlink_get_description(sd_varlink *link);

DESCRIPTION         top

       sd_varlink_set_description() sets the description string that is
       used in logging to the specified string. The string is copied
       internally and freed when the Varlink connection object is
       deallocated. The description argument may be NULL, in which case
       the description is unset.

       sd_varlink_get_description() returns a description string for the
       specified Varlink connection. This string may have been previously
       set with sd_varlink_set_description(). If not set this way, a
       default string or NULL may be returned, depending how the
       connection was allocated and set up.

RETURN VALUE         top

       On success, sd_varlink_set_description() returns a non-negative
       integer. On failure, it returns a negative errno-style error code.
       sd_varlink_get_description() returns either NULL or a pointer to
       the description string.

   Errors
       Returned errors may indicate the following problems:

       -EINVAL
           An argument is invalid.

       -ENOMEM
           Memory allocation failed.

NOTES         top

       Functions described here are available as a shared library, which
       can be compiled against and linked to with the
       libsystemd pkg-config(1) file.

       The code described here uses getenv(3), which is declared to be
       not multi-thread-safe. This means that the code calling the
       functions described here must not call setenv(3) from a parallel
       thread. It is recommended to only do calls to setenv() from an
       early phase of the program when no other threads have been
       started.

HISTORY         top

       sd_varlink_set_description() was added in version 257.

       sd_varlink_get_description() was added in version 258.

SEE ALSO         top

       systemd(1), sd-varlink(3)

COLOPHON         top

       This page is part of the systemd (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-02-02.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2025-02-02.)  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 is not part of the original manual page), send a mail to
       man-pages@man7.org

systemd 258~devel                                  SD_VARLI...CRIPTION(3)

Pages that refer to this page: systemd.directives(7)systemd.index(7)