man-pages/man3/sd_bus_slot_set_description.3.html
2021-03-31 01:06:50 +01:00

142 lines
3.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of SD_BUS_SLOT_SET_DESCRIPTION</TITLE>
</HEAD><BODY>
<H1>SD_BUS_SLOT_SET_DESCRIPTION</H1>
Section: sd_bus_slot_set_description (3)<BR>Updated: <BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
sd_bus_slot_set_description, sd_bus_slot_get_description - Set or query the description of bus slot objects
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<P>
<B>
</B><PRE>
#include &lt;<A HREF="file:///usr/include/systemd/sd-bus.h">systemd/sd-bus.h</A>&gt;
</PRE>
<DL COMPACT>
<DT id="1">
<B>int sd_bus_slot_set_description(sd_bus_slot*&nbsp;</B><I>slot</I><B>, const&nbsp;char&nbsp;*</B><I>description</I><B>);</B>
<DT id="2">
<B>int sd_bus_slot_get_description(sd_bus_slot*&nbsp;</B><I>bus</I><B>, const&nbsp;char&nbsp;**</B><I>description</I><B>);</B>
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<B>sd_bus_slot_set_description()</B>
<DD>sets the description string that is used in logging to the specified string. The string is copied internally and freed when the bus slot object is deallocated. The
<I>description</I>
argument may be
<B>NULL</B>, in which case the description is unset.
<P>
<B>sd_bus_slot_get_description()</B>
returns a description string in
<I>description</I>. If the string is not set, e.g. with
<B>sd_bus_slot_set_description()</B>, and the slot is a bus match callback slot, the match string will be returned. Otherwise,
<B>-ENXIO</B>
is returned.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
<P>
On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style error code.
<A NAME="lbAF">&nbsp;</A>
<H3>Errors</H3>
<P>
Returned errors may indicate the following problems:
<P>
<B>-EINVAL</B>
<DL COMPACT><DT id="3"><DD>
An required argument is
<B>NULL</B>.
</DL>
<P>
<B>-ENXIO</B>
<DL COMPACT><DT id="4"><DD>
The bus slot object has no description.
</DL>
<P>
<B>-ENOMEM</B>
<DL COMPACT><DT id="5"><DD>
Memory allocation failed.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>NOTES</H2>
<P>
These APIs are implemented as a shared library, which can be compiled and linked to with the
<B>libsystemd</B>&nbsp;<B><A HREF="/cgi-bin/man/man2html?1+pkg-config">pkg-config</A></B>(1)
file.
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?1+systemd">systemd</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?3+sd-bus">sd-bus</A></B>(3)
<B><A HREF="/cgi-bin/man/man2html?3+sd_bus_slot_ref">sd_bus_slot_ref</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+sd_bus_slot_set_userdata">sd_bus_slot_set_userdata</A></B>(3)
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="6"><A HREF="#lbAB">NAME</A><DD>
<DT id="7"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="8"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="9"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DL>
<DT id="10"><A HREF="#lbAF">Errors</A><DD>
</DL>
<DT id="11"><A HREF="#lbAG">NOTES</A><DD>
<DT id="12"><A HREF="#lbAH">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:55 GMT, March 31, 2021
</BODY>
</HTML>