sd_bus_call_method(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | SEE ALSO | COLOPHON

SD_BUS_CALL_METHOD(3)      sd_bus_call_method      SD_BUS_CALL_METHOD(3)

NAME         top

       sd_bus_call_method, sd_bus_call_methodv,
       sd_bus_call_method_async, sd_bus_call_method_asyncv - Initialize
       a bus message object and invoke the corresponding D-Bus method
       call

SYNOPSIS         top

       #include <systemd/sd-bus.h>

       typedef int (*sd_bus_message_handler_t)(sd_bus_message *m,
                                               void *userdata,
                                               sd_bus_error *ret_error);

       int sd_bus_call_method(sd_bus *bus, const char *destination,
                              const char *path, const char *interface,
                              const char *member,
                              sd_bus_error *ret_error,
                              sd_bus_message **reply, const char *types,
                              ...);

       int sd_bus_call_methodv(sd_bus *bus, const char *destination,
                               const char *path, const char *interface,
                               const char *member,
                               sd_bus_error *ret_error,
                               sd_bus_message **reply,
                               const char *types, va_list ap);

       int sd_bus_call_method_async(sd_bus *bus, sd_bus_slot **slot,
                                    const char *destination,
                                    const char *path,
                                    const char *interface,
                                    const char *member,
                                    sd_bus_message_handler_t callback,
                                    void *userdata, const char *types,
                                    ...);

       int sd_bus_call_method_asyncv(sd_bus *bus, sd_bus_slot **slot,
                                     const char *destination,
                                     const char *path,
                                     const char *interface,
                                     const char *member,
                                     sd_bus_message_handler_t callback,
                                     void *userdata, const char *types,
                                     va_list ap);

DESCRIPTION         top

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

       sd_bus_call_method_async() is a convenience function for
       initializing a bus message object and calling the corresponding
       D-Bus method asynchronously. It combines the
       sd_bus_message_new_method_call(3), sd_bus_message_append(3) and
       sd_bus_call_async(3) functions into a single function call.

RETURN VALUE         top

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

   Errors
       See the man pages of sd_bus_message_new_method_call(3),
       sd_bus_message_append(3), sd_bus_call(3) and sd_bus_call_async(3)
       for a list of possible errors.

NOTES         top

       These APIs are implemented as a shared library, which can be
       compiled and linked to with the libsystemd pkg-config(1) file.

SEE ALSO         top

       systemd(1), sd-bus(3), sd_bus_message_new_method_call(3),
       sd_bus_message_append(3), sd_bus_call(3), sd_bus_set_property(3),
       sd_bus_emit_signal(3)

COLOPHON         top

       This page is part of the systemd (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 2022-12-17.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2022-12-16.)  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 is not part of the original manual page), send a mail to
       man-pages@man7.org

systemd 252                                        SD_BUS_CALL_METHOD(3)

Pages that refer to this page: sd-bus(3)sd_bus_call(3)sd_bus_emit_signal(3)sd_bus_interface_name_is_valid(3)sd_bus_message_new_method_call(3)sd_bus_send(3)sd_bus_set_property(3)sd_bus_slot_ref(3)systemd.directives(7)systemd.index(7)