[thirdparty/systemd.git] / man / sd_bus_set_property.xml

<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1+ -->

<refentry id="sd_bus_set_property"
          xmlns:xi="http://www.w3.org/2001/XInclude">

  <refentryinfo>
    <title>sd_bus_set_property</title>
    <productname>systemd</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>sd_bus_set_property</refentrytitle>
    <manvolnum>3</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>sd_bus_set_property</refname>
    <refname>sd_bus_set_propertyv</refname>
    <refname>sd_bus_get_property</refname>
    <refname>sd_bus_get_property_trivial</refname>
    <refname>sd_bus_get_property_string</refname>
    <refname>sd_bus_get_property_strv</refname>

    <refpurpose>Set or query D-Bus service properties</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <funcsynopsis>
      <funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>

      <funcprototype>
        <funcdef>int <function>sd_bus_set_property</function></funcdef>
        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
        <paramdef>const char *<parameter>destination</parameter></paramdef>
        <paramdef>const char *<parameter>path</parameter></paramdef>
        <paramdef>const char *<parameter>interface</parameter></paramdef>
        <paramdef>const char *<parameter>member</parameter></paramdef>
        <paramdef>sd_bus_error *<parameter>ret_error</parameter></paramdef>
        <paramdef>sd_bus_message **<parameter>reply</parameter></paramdef>
        <paramdef>const char *<parameter>type</parameter></paramdef>
        <paramdef>...</paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>int <function>sd_bus_set_propertyv</function></funcdef>
        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
        <paramdef>const char *<parameter>destination</parameter></paramdef>
        <paramdef>const char *<parameter>path</parameter></paramdef>
        <paramdef>const char *<parameter>interface</parameter></paramdef>
        <paramdef>const char *<parameter>member</parameter></paramdef>
        <paramdef>sd_bus_error *<parameter>ret_error</parameter></paramdef>
        <paramdef>sd_bus_message **<parameter>reply</parameter></paramdef>
        <paramdef>const char *<parameter>type</parameter></paramdef>
        <paramdef>va_list <parameter>ap</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>int <function>sd_bus_get_property</function></funcdef>
        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
        <paramdef>const char *<parameter>destination</parameter></paramdef>
        <paramdef>const char *<parameter>path</parameter></paramdef>
        <paramdef>const char *<parameter>interface</parameter></paramdef>
        <paramdef>const char *<parameter>member</parameter></paramdef>
        <paramdef>sd_bus_error *<parameter>ret_error</parameter></paramdef>
        <paramdef>sd_bus_message **<parameter>reply</parameter></paramdef>
        <paramdef>const char *<parameter>type</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>int <function>sd_bus_get_property_trivial</function></funcdef>
        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
        <paramdef>const char *<parameter>destination</parameter></paramdef>
        <paramdef>const char *<parameter>path</parameter></paramdef>
        <paramdef>const char *<parameter>interface</parameter></paramdef>
        <paramdef>const char *<parameter>member</parameter></paramdef>
        <paramdef>sd_bus_error *<parameter>ret_error</parameter></paramdef>
        <paramdef>char <parameter>type</parameter></paramdef>
        <paramdef>void *<parameter>ret_ptr</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>int <function>sd_bus_get_property_string</function></funcdef>
        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
        <paramdef>const char *<parameter>destination</parameter></paramdef>
        <paramdef>const char *<parameter>path</parameter></paramdef>
        <paramdef>const char *<parameter>interface</parameter></paramdef>
        <paramdef>const char *<parameter>member</parameter></paramdef>
        <paramdef>sd_bus_error *<parameter>ret_error</parameter></paramdef>
        <paramdef>char **<parameter>ret</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>int <function>sd_bus_get_property_strv</function></funcdef>
        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
        <paramdef>const char *<parameter>destination</parameter></paramdef>
        <paramdef>const char *<parameter>path</parameter></paramdef>
        <paramdef>const char *<parameter>interface</parameter></paramdef>
        <paramdef>const char *<parameter>member</parameter></paramdef>
        <paramdef>sd_bus_error *<parameter>ret_error</parameter></paramdef>
        <paramdef>char ***<parameter>ret</parameter></paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para>These functions set or query D-Bus properties. D-Bus properties are service fields exposed
    via the <constant>org.freedesktop.DBus.Properties</constant> interface. Under the hood, these
    functions call methods of the <constant>org.freedesktop.DBus.Properties</constant> interface and
    as a result their semantics are similar to
    <citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
    </para>

    <para><function>sd_bus_set_property()</function> sets a D-Bus property. On success, the response
    is stored in <parameter>reply</parameter>. If setting the property fails or an internal error
    occurs, an error is returned and an extended description of the error is optionally stored in
    <parameter>ret_error</parameter> if it is not <constant>NULL</constant>.
    <parameter>type</parameter> and the arguments that follow it describe the new value of the
    property and must follow the format described in
    <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
    </para>

    <para><function>sd_bus_set_propertyv()</function> is equivalent to
    <function>sd_bus_set_property()</function>, except that it is called with a
    <literal>va_list</literal> instead of a variable number of arguments.</para>

    <para><function>sd_bus_get_property()</function> queries a D-Bus property. If retrieving the
    property fails or an internal error occurs, an error is returned and an extended description of
    the error is optionally stored in <parameter>ret_error</parameter> if it is not
    <constant>NULL</constant>. On success, the property is stored in <parameter>reply</parameter>.
    <parameter>type</parameter> describes the property type and must follow the format described in
    <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
    </para>

    <para><function>sd_bus_get_property_trivial()</function>,
    <function>sd_bus_get_property_string()</function> and
    <function>sd_bus_get_property_strv()</function> are shorthands for
    <function>sd_bus_get_property()</function> that are used to query basic, string and string
    vector properties respectively. The caller is responsible for freeing the string and string
    vector results stored in <parameter>ret</parameter> by
    <function>sd_bus_get_property_string()</function> and
    <function>sd_bus_get_property_strv()</function>.</para>
  </refsect1>

  <refsect1>
    <title>Return Value</title>

    <para>On success, these functions return a non-negative integer. On failure, they return a
    negative errno-style error code.</para>

    <refsect2 id='errors'>
      <title>Errors</title>

      <para>See the
      <citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry>
      man page for a list of possible errors</para>
    </refsect2>
  </refsect1>

  <xi:include href="libsystemd-pkgconfig.xml" />

  <refsect1>
    <title>See Also</title>

    <para>
      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>
Commit	Line	Data
4b7f8d78 DDM	1	<?xml version='1.0'?>
	2	<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
	3	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
	4	<!-- SPDX-License-Identifier: LGPL-2.1+ -->
	5
	6	<refentry id="sd_bus_set_property"
	7	xmlns:xi="http://www.w3.org/2001/XInclude">
	8
	9	<refentryinfo>
	10	<title>sd_bus_set_property</title>
	11	<productname>systemd</productname>
	12	</refentryinfo>
	13
	14	<refmeta>
	15	<refentrytitle>sd_bus_set_property</refentrytitle>
	16	<manvolnum>3</manvolnum>
	17	</refmeta>
	18
	19	<refnamediv>
	20	<refname>sd_bus_set_property</refname>
	21	<refname>sd_bus_set_propertyv</refname>
	22	<refname>sd_bus_get_property</refname>
	23	<refname>sd_bus_get_property_trivial</refname>
	24	<refname>sd_bus_get_property_string</refname>
	25	<refname>sd_bus_get_property_strv</refname>
	26
	27	<refpurpose>Set or query D-Bus service properties</refpurpose>
	28	</refnamediv>
	29
	30	<refsynopsisdiv>
	31	<funcsynopsis>
	32	<funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo>
	33
	34	<funcprototype>
	35	<funcdef>int <function>sd_bus_set_property</function></funcdef>
	36	<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
	37	<paramdef>const char *<parameter>destination</parameter></paramdef>
	38	<paramdef>const char *<parameter>path</parameter></paramdef>
	39	<paramdef>const char *<parameter>interface</parameter></paramdef>
	40	<paramdef>const char *<parameter>member</parameter></paramdef>
	41	<paramdef>sd_bus_error *<parameter>ret_error</parameter></paramdef>
	42	<paramdef>sd_bus_message **<parameter>reply</parameter></paramdef>
	43	<paramdef>const char *<parameter>type</parameter></paramdef>
	44	<paramdef>...</paramdef>
	45	</funcprototype>
	46
	47	<funcprototype>
	48	<funcdef>int <function>sd_bus_set_propertyv</function></funcdef>
	49	<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
	50	<paramdef>const char *<parameter>destination</parameter></paramdef>
	51	<paramdef>const char *<parameter>path</parameter></paramdef>
	52	<paramdef>const char *<parameter>interface</parameter></paramdef>
	53	<paramdef>const char *<parameter>member</parameter></paramdef>
	54	<paramdef>sd_bus_error *<parameter>ret_error</parameter></paramdef>
	55	<paramdef>sd_bus_message **<parameter>reply</parameter></paramdef>
	56	<paramdef>const char *<parameter>type</parameter></paramdef>
	57	<paramdef>va_list <parameter>ap</parameter></paramdef>
	58	</funcprototype>
	59
	60	<funcprototype>
	61	<funcdef>int <function>sd_bus_get_property</function></funcdef>
	62	<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
	63	<paramdef>const char *<parameter>destination</parameter></paramdef>
	64	<paramdef>const char *<parameter>path</parameter></paramdef>
65	<paramdef>const char *<parameter>interface</parameter></paramdef>
66	<paramdef>const char *<parameter>member</parameter></paramdef>
67	<paramdef>sd_bus_error *<parameter>ret_error</parameter></paramdef>
68	<paramdef>sd_bus_message **<parameter>reply</parameter></paramdef>
69	<paramdef>const char *<parameter>type</parameter></paramdef>
70	</funcprototype>
71
72	<funcprototype>
73	<funcdef>int <function>sd_bus_get_property_trivial</function></funcdef>
74	<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
75	<paramdef>const char *<parameter>destination</parameter></paramdef>
76	<paramdef>const char *<parameter>path</parameter></paramdef>
77	<paramdef>const char *<parameter>interface</parameter></paramdef>
78	<paramdef>const char *<parameter>member</parameter></paramdef>
79	<paramdef>sd_bus_error *<parameter>ret_error</parameter></paramdef>
80	<paramdef>char <parameter>type</parameter></paramdef>
81	<paramdef>void *<parameter>ret_ptr</parameter></paramdef>
82	</funcprototype>
83
84	<funcprototype>
85	<funcdef>int <function>sd_bus_get_property_string</function></funcdef>
86	<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
87	<paramdef>const char *<parameter>destination</parameter></paramdef>
88	<paramdef>const char *<parameter>path</parameter></paramdef>
89	<paramdef>const char *<parameter>interface</parameter></paramdef>
90	<paramdef>const char *<parameter>member</parameter></paramdef>
91	<paramdef>sd_bus_error *<parameter>ret_error</parameter></paramdef>
92	<paramdef>char **<parameter>ret</parameter></paramdef>
93	</funcprototype>
94
95	<funcprototype>
96	<funcdef>int <function>sd_bus_get_property_strv</function></funcdef>
97	<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
98	<paramdef>const char *<parameter>destination</parameter></paramdef>
99	<paramdef>const char *<parameter>path</parameter></paramdef>
100	<paramdef>const char *<parameter>interface</parameter></paramdef>
101	<paramdef>const char *<parameter>member</parameter></paramdef>
102	<paramdef>sd_bus_error *<parameter>ret_error</parameter></paramdef>
103	<paramdef>char ***<parameter>ret</parameter></paramdef>
104	</funcprototype>
105	</funcsynopsis>
106	</refsynopsisdiv>
107
108	<refsect1>
109	<title>Description</title>
110
111	<para>These functions set or query D-Bus properties. D-Bus properties are service fields exposed
112	via the <constant>org.freedesktop.DBus.Properties</constant> interface. Under the hood, these
113	functions call methods of the <constant>org.freedesktop.DBus.Properties</constant> interface and
114	as a result their semantics are similar to
115	<citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
116	</para>
117
118	<para><function>sd_bus_set_property()</function> sets a D-Bus property. On success, the response
119	is stored in <parameter>reply</parameter>. If setting the property fails or an internal error
120	occurs, an error is returned and an extended description of the error is optionally stored in
121	<parameter>ret_error</parameter> if it is not <constant>NULL</constant>.
122	<parameter>type</parameter> and the arguments that follow it describe the new value of the
123	property and must follow the format described in
124	<citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
125	</para>
126
127	<para><function>sd_bus_set_propertyv()</function> is equivalent to
128	<function>sd_bus_set_property()</function>, except that it is called with a
129	<literal>va_list</literal> instead of a variable number of arguments.</para>
130
131	<para><function>sd_bus_get_property()</function> queries a D-Bus property. If retrieving the
132	property fails or an internal error occurs, an error is returned and an extended description of
133	the error is optionally stored in <parameter>ret_error</parameter> if it is not
134	<constant>NULL</constant>. On success, the property is stored in <parameter>reply</parameter>.
135	<parameter>type</parameter> describes the property type and must follow the format described in
136	<citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
137	</para>
138
139	<para><function>sd_bus_get_property_trivial()</function>,
140	<function>sd_bus_get_property_string()</function> and
141	<function>sd_bus_get_property_strv()</function> are shorthands for
142	<function>sd_bus_get_property()</function> that are used to query basic, string and string
143	vector properties respectively. The caller is responsible for freeing the string and string
144	vector results stored in <parameter>ret</parameter> by
145	<function>sd_bus_get_property_string()</function> and
146	<function>sd_bus_get_property_strv()</function>.</para>
147	</refsect1>
148
149	<refsect1>
150	<title>Return Value</title>
151
152	<para>On success, these functions return a non-negative integer. On failure, they return a
153	negative errno-style error code.</para>
154
155	<refsect2 id='errors'>
156	<title>Errors</title>
157
158	<para>See the
159	<citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry>
160	man page for a list of possible errors</para>
161	</refsect2>
162	</refsect1>
163
164	<xi:include href="libsystemd-pkgconfig.xml" />
165
166	<refsect1>
167	<title>See Also</title>
168
169	<para>
170	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
171	<citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
172	<citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry>
173	</para>
174	</refsect1>
175
176	</refentry>