SD\_VARLINK\_SET\_DESCRIPTION(3) sd\_varlink\_set\_description SD\_VARLINK\_SET\_DESCRIPTION(3)

.SH "NAME" sd\_varlink\_set\_description, sd\_varlink\_get\_description - Set or query description of a Varlink connection object

.SH "SYNOPSIS"

```
#include <systemd/sd-varlink.h>
```

.HP 744u **int sd\_varlink\_set\_description(sd\_varlink \*link, const char \*description);**

.HP 936u **const char* sd\_varlink\_get\_description(sd\_varlink \*link);**

.SH "DESCRIPTION"

.PP **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.

.PP **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.

.SH "RETURN VALUE"

.PP 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.

.SS "Errors"

.PP Returned errors may indicate the following problems:

.PP **-EINVAL**

An argument is invalid.

.RE

.PP **-ENOMEM**

Memory allocation failed.

.RE

.SH "NOTES"

.PP Functions described here are available as a shared library, which can be compiled against and linked to with the **libsystemd** [**pkg-config**(1)](/man/os/systemd/pkg-config.1) file.

.PP The code described here uses [**getenv**(3)](/man/os/systemd/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)](/man/os/systemd/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.

.SH "HISTORY"

.PP **sd\_varlink\_set\_description()** was added in version 257.

.PP **sd\_varlink\_get\_description()** was added in version 258.

.SH "SEE ALSO"

.PP [**systemd**(1)](/man/os/systemd/systemd.1), [**sd-varlink**(3)](/man/os/systemd/sd-varlink.3)

systemd 262.2

---

Document: sd_varlink_set_description(3) from systemd 262.2-r1 (Chainguard OS)
Source: https://github.com/systemd/systemd