sd_bus_reply_method_error(3) — Linux manual page

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

SD_BUS_REPLY_METHOD_ERROR(3)_bus_reply_method_errorBUS_REPLY_METHOD_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
       sd_bus_message_new_method_error().

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

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

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.

   Errors
       Returned errors may indicate the following problems:

       -EINVAL
           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 error to sd_bus_reply_method_error is not
           set, see sd_bus_error_is_set(3).

       -EPERM
           Message call has been sealed.

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

       -ENOMEM
           Memory allocation failed.

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

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_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 
       ⟨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 2020-08-13.  (At that
       time, the date of the most recent commit that was found in the repos‐
       itory was 2020-08-11.)  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 246                                     SD_BUS_REPLY_METHOD_ERROR(3)

Pages that refer to this page: sd-bus(3)sd_bus_add_fallback(3)sd_bus_add_fallback_vtable(3)sd_bus_add_filter(3)sd_bus_add_object(3)sd_bus_add_object_vtable(3)sd_bus_method(3)SD_BUS_METHOD(3)sd_bus_method_with_names(3)SD_BUS_METHOD_WITH_NAMES(3)sd_bus_method_with_names_offset(3)SD_BUS_METHOD_WITH_NAMES_OFFSET(3)sd_bus_method_with_offset(3)SD_BUS_METHOD_WITH_OFFSET(3)sd_bus_param(3)SD_BUS_PARAM(3)sd_bus_property(3)SD_BUS_PROPERTY(3)sd_bus_signal(3)SD_BUS_SIGNAL(3)sd_bus_signal_with_names(3)SD_BUS_SIGNAL_WITH_NAMES(3)sd_bus_vtable_end(3)SD_BUS_VTABLE_END(3)sd_bus_vtable_start(3)SD_BUS_VTABLE_START(3)sd_bus_writable_property(3)SD_BUS_WRITABLE_PROPERTY(3)30-systemd-environment-d-generator(7)systemd.directives(7)systemd.index(7)