[thirdparty/systemd.git] / man / sd_bus_call_method.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_call_method"
          xmlns:xi="http://www.w3.org/2001/XInclude">

  <refentryinfo>
    <title>sd_bus_call_method</title>
    <productname>systemd</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>sd_bus_call_method</refentrytitle>
    <manvolnum>3</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>sd_bus_call_method</refname>
    <refname>sd_bus_call_methodv</refname>
    <refname>sd_bus_call_method_async</refname>
    <refname>sd_bus_call_method_asyncv</refname>

    <refpurpose>Initialize a bus message object and invoke the corresponding D-Bus method call
    </refpurpose>
  </refnamediv>

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

      <funcprototype>
        <funcdef>int <function>sd_bus_call_method</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>types</parameter></paramdef>
        <paramdef>...</paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>int <function>sd_bus_call_methodv</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>types</parameter></paramdef>
        <paramdef>va_list <parameter>ap</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>int <function>sd_bus_call_method_async</function></funcdef>
        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
        <paramdef>sd_bus_slot **<parameter>slot</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_message_handler_t <parameter>callback</parameter></paramdef>
        <paramdef>void *<parameter>userdata</parameter></paramdef>
        <paramdef>const char *<parameter>types</parameter></paramdef>
        <paramdef>...</paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>int <function>sd_bus_call_method_asyncv</function></funcdef>
        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
        <paramdef>sd_bus_slot **<parameter>slot</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_message_handler_t <parameter>callback</parameter></paramdef>
        <paramdef>void *<parameter>userdata</parameter></paramdef>
        <paramdef>const char *<parameter>types</parameter></paramdef>
        <paramdef>va_list <parameter>ap</parameter></paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><function>sd_bus_call_method()</function> is a convenience function for initializing a
    bus message object and calling the corresponding D-Bus method. It combines the
    <citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
    <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
    <citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>
    functions into a single function call.</para>

    <para><function>sd_bus_call_method_async()</function> is a convenience function for initializing
    a bus message object and calling the corresponding D-Bus method asynchronously. It combines the
    <citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
    <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
    <citerefentry><refentrytitle>sd_bus_call_async</refentrytitle><manvolnum>3</manvolnum></citerefentry>
    functions into a single function call.</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 man pages of
      <citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
      <citerefentry><refentrytitle>sd_bus_call_async</refentrytitle><manvolnum>3</manvolnum></citerefentry>
      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_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>sd_bus_set_property</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>sd_bus_emit_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>
Commit	Line	Data
9735c644 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_call_method"
	7	xmlns:xi="http://www.w3.org/2001/XInclude">
	8
	9	<refentryinfo>
	10	<title>sd_bus_call_method</title>
	11	<productname>systemd</productname>
	12	</refentryinfo>
	13
	14	<refmeta>
	15	<refentrytitle>sd_bus_call_method</refentrytitle>
	16	<manvolnum>3</manvolnum>
	17	</refmeta>
	18
	19	<refnamediv>
	20	<refname>sd_bus_call_method</refname>
935052a8	21	<refname>sd_bus_call_methodv</refname>
9735c644	22	<refname>sd_bus_call_method_async</refname>
935052a8	23	<refname>sd_bus_call_method_asyncv</refname>
9735c644	24
953ee402 DDM	25	<refpurpose>Initialize a bus message object and invoke the corresponding D-Bus method call
953ee402 DDM	26	</refpurpose>
9735c644 DDM	27	</refnamediv>
	28
	29	<refsynopsisdiv>
	30	<funcsynopsis>
	31	<funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo>
	32
	33	<funcprototype>
	34	<funcdef>int <function>sd_bus_call_method</function></funcdef>
	35	<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
	36	<paramdef>const char *<parameter>destination</parameter></paramdef>
	37	<paramdef>const char *<parameter>path</parameter></paramdef>
	38	<paramdef>const char *<parameter>interface</parameter></paramdef>
	39	<paramdef>const char *<parameter>member</parameter></paramdef>
	40	<paramdef>sd_bus_error *<parameter>ret_error</parameter></paramdef>
	41	<paramdef>sd_bus_message **<parameter>reply</parameter></paramdef>
	42	<paramdef>const char *<parameter>types</parameter></paramdef>
	43	<paramdef>...</paramdef>
	44	</funcprototype>
	45
935052a8 VC	46	<funcprototype>
	47	<funcdef>int <function>sd_bus_call_methodv</function></funcdef>
	48	<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
	49	<paramdef>const char *<parameter>destination</parameter></paramdef>
	50	<paramdef>const char *<parameter>path</parameter></paramdef>
	51	<paramdef>const char *<parameter>interface</parameter></paramdef>
	52	<paramdef>const char *<parameter>member</parameter></paramdef>
	53	<paramdef>sd_bus_error *<parameter>ret_error</parameter></paramdef>
	54	<paramdef>sd_bus_message **<parameter>reply</parameter></paramdef>
	55	<paramdef>const char *<parameter>types</parameter></paramdef>
	56	<paramdef>va_list <parameter>ap</parameter></paramdef>
	57	</funcprototype>
	58
9735c644 DDM	59	<funcprototype>
	60	<funcdef>int <function>sd_bus_call_method_async</function></funcdef>
	61	<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
	62	<paramdef>sd_bus_slot **<parameter>slot</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_message_handler_t <parameter>callback</parameter></paramdef>
	68	<paramdef>void *<parameter>userdata</parameter></paramdef>
	69	<paramdef>const char *<parameter>types</parameter></paramdef>
	70	<paramdef>...</paramdef>
	71	</funcprototype>
935052a8 VC	72
	73	<funcprototype>
	74	<funcdef>int <function>sd_bus_call_method_asyncv</function></funcdef>
	75	<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
	76	<paramdef>sd_bus_slot **<parameter>slot</parameter></paramdef>
	77	<paramdef>const char *<parameter>destination</parameter></paramdef>
	78	<paramdef>const char *<parameter>path</parameter></paramdef>
	79	<paramdef>const char *<parameter>interface</parameter></paramdef>
	80	<paramdef>const char *<parameter>member</parameter></paramdef>
	81	<paramdef>sd_bus_message_handler_t <parameter>callback</parameter></paramdef>
	82	<paramdef>void *<parameter>userdata</parameter></paramdef>
	83	<paramdef>const char *<parameter>types</parameter></paramdef>
	84	<paramdef>va_list <parameter>ap</parameter></paramdef>
	85	</funcprototype>
9735c644 DDM	86	</funcsynopsis>
	87	</refsynopsisdiv>
	88
	89	<refsect1>
	90	<title>Description</title>
	91
953ee402 DDM	92	<para><function>sd_bus_call_method()</function> is a convenience function for initializing a
953ee402 DDM	93	bus message object and calling the corresponding D-Bus method. It combines the
9735c644 DDM	94	<citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
	95	<citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
	96	<citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>
	97	functions into a single function call.</para>
	98
953ee402 DDM	99	<para><function>sd_bus_call_method_async()</function> is a convenience function for initializing
953ee402 DDM	100	a bus message object and calling the corresponding D-Bus method asynchronously. It combines the
9735c644 DDM	101	<citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
	102	<citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
	103	<citerefentry><refentrytitle>sd_bus_call_async</refentrytitle><manvolnum>3</manvolnum></citerefentry>
	104	functions into a single function call.</para>
	105	</refsect1>
	106
	107	<refsect1>
	108	<title>Return Value</title>
	109
953ee402	110	<para>On success, these functions return a non-negative integer. On failure, they return a
9735c644 DDM	111	negative errno-style error code.</para>
	112
	113	<refsect2 id='errors'>
	114	<title>Errors</title>
	115
	116	<para>See the man pages of
	117	<citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
	118	<citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
	119	<citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
	120	<citerefentry><refentrytitle>sd_bus_call_async</refentrytitle><manvolnum>3</manvolnum></citerefentry>
	121	for a list of possible errors.</para>
	122	</refsect2>
	123	</refsect1>
	124
	125	<xi:include href="libsystemd-pkgconfig.xml" />
	126
	127	<refsect1>
	128	<title>See Also</title>
	129
	130	<para>
	131	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
	132	<citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
	133	<citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
	134	<citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
	135	<citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
4b7f8d78	136	<citerefentry><refentrytitle>sd_bus_set_property</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
ad300028	137	<citerefentry><refentrytitle>sd_bus_emit_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>
9735c644 DDM	138	</para>
	139	</refsect1>
	140
	141	</refentry>