sd_bus_reply_method_error(3) — Linux manual page


SD_BUS_R...HOD_ERROR(3) sd_bus_reply_method_errorSD_BUS_R...HOD_ERROR(3)

NAME         top

       sd_bus_reply_method_error, sd_bus_reply_method_errorf,
       sd_bus_reply_method_errorfv, sd_bus_reply_method_errno,
       sd_bus_reply_method_errnof, sd_bus_reply_method_errnofv - Reply
       with an error to a D-Bus method call

SYNOPSIS         top

       #include <systemd/sd-bus.h>

       int sd_bus_reply_method_error(sd_bus_message *call,
                                     const sd_bus_error *e);

       int sd_bus_reply_method_errorf(sd_bus_message *call,
                                      const char *name,
                                      const char *format, ...);

       int sd_bus_reply_method_errorfv(sd_bus_message *call,
                                       const char *name,
                                       const char *format, va_list ap);

       int sd_bus_reply_method_errno(sd_bus_message *call, int error,
                                     const sd_bus_error *p);

       int sd_bus_reply_method_errnof(sd_bus_message *call, int error,
                                      const char *format, ...);

       int sd_bus_reply_method_errnofv(sd_bus_message *call, int error,
                                       const char *format, va_list ap);

DESCRIPTION         top

       The sd_bus_reply_method_error() function sends an error reply to
       the call message. The error structure e specifies the error to
       send, and is used as described in
       sd_bus_message_new_method_error(3). If no reply is expected to
       call, this function succeeds without sending a reply.

       The sd_bus_reply_method_errorf() is to
       sd_bus_reply_method_error() what
       sd_bus_message_new_method_errorf() is to

       The sd_bus_reply_method_errno() is to sd_bus_reply_method_error()
       what sd_bus_message_new_method_errno() is to

       The sd_bus_reply_method_errnof() is to
       sd_bus_reply_method_error() what
       sd_bus_message_new_method_errnof() is to

RETURN VALUE         top

       This function returns a non-negative integer if the error reply
       was successfully sent or if call does not expect a reply. On
       failure, it returns a negative errno-style error code.

       Returned errors may indicate the following problems:

           The input parameter call is NULL.

           Message call is not a method call message.

           Message call is not attached to a bus.

           The error parameter e to sd_bus_reply_method_error() is not
           set, see sd_bus_error_is_set(3).

           Message call has been sealed.

           The bus to which message call is attached is not connected.

           Memory allocation failed.

       In addition, any error returned by sd_bus_send(1) may be

NOTES         top

       Functions described here are available as a shared library, which
       can be compiled against and linked to with the
       libsystemd pkg-config(1) file.

       The code described here uses 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) 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

SEE ALSO         top

       systemd(1), sd-bus(3), sd_bus_message_new_method_error(3)

COLOPHON         top

       This page is part of the systemd (systemd system and service
       manager) project.  Information about the project can be found at
       ⟨⟩.  If you have
       a bug report for this manual page, see
       This page was obtained from the project's upstream Git repository
       ⟨⟩ on 2023-12-22.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2023-12-22.)  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

systemd 255                                      SD_BUS_R...HOD_ERROR(3)

Pages that refer to this page: sd-bus(3)sd_bus_add_object(3)systemd.directives(7)systemd.index(7)