NAME |SYNOPSIS |DESCRIPTION |RETURN VALUE |NOTES |HISTORY |SEE ALSO |COLOPHON | |
SD_VARLI...CRIPTION(3) sd_varlink_set_descriptionSD_VARLI...CRIPTION(3)sd_varlink_set_description, sd_varlink_get_description - Set or query description of a Varlink connection object
#include <systemd/sd-varlink.h>int sd_varlink_set_description(sd_varlink *link,const char *description);const char* sd_varlink_get_description(sd_varlink *link);
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. Thedescription argument may beNULL, 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 withsd_varlink_set_description(). If not set this way, a default string orNULLmay be returned, depending how the connection was allocated and set up.
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 eitherNULLor a pointer to the description string.Errors Returned errors may indicate the following problems:-EINVAL An argument is invalid.-ENOMEM Memory allocation failed.
Functions described here are available as a shared library, which can be compiled against and linked to with thelibsystemd pkg-config(1) file. The code described here usesgetenv(3), which is declared to be not multi-thread-safe. This means that the code calling the functions described here must not callsetenv(3) from a parallel thread. It is recommended to only do calls tosetenv()from an early phase of the program when no other threads have been started.
sd_varlink_set_description()was added in version 257.sd_varlink_get_description()was added in version 258.
systemd(1),sd-varlink(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_VARLI...CRIPTION(3)Pages that refer to this page: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. | ![]() |