diff --git a/man/rules/meson.build b/man/rules/meson.build index 74f057c013..5dadd5fc6c 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -229,6 +229,12 @@ manpages = [ ['sd_bus_path_decode', 'sd_bus_path_decode_many', 'sd_bus_path_encode_many'], ''], ['sd_bus_process', '3', [], ''], + ['sd_bus_reply_method_error', + '3', + ['sd_bus_reply_method_errno', + 'sd_bus_reply_method_errnof', + 'sd_bus_reply_method_errorf'], + ''], ['sd_bus_request_name', '3', ['sd_bus_release_name', diff --git a/man/sd-bus.xml b/man/sd-bus.xml index 627c7195ed..a84af2b878 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -68,6 +68,7 @@ sd_bus_new3, sd_bus_path_encode3, sd_bus_process3, +sd_bus_reply_method_error3, sd_bus_request_name3, sd_bus_set_connected_signal3, sd_bus_set_sender3, diff --git a/man/sd_bus_reply_method_error.xml b/man/sd_bus_reply_method_error.xml new file mode 100644 index 0000000000..bbb916dc32 --- /dev/null +++ b/man/sd_bus_reply_method_error.xml @@ -0,0 +1,161 @@ + + + + + + + + + sd_bus_reply_method_error + systemd + + + + sd_bus_reply_method_error + 3 + + + + sd_bus_reply_method_error + sd_bus_reply_method_errorf + sd_bus_reply_method_errno + sd_bus_reply_method_errnof + + Reply with an error to a method call + + + + + #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_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 + + + + + + + Description + + 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_error3. + If no reply is expected to call, this function returns + success without sending 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 + + These functions return 0 if the error reply was successfully sent or if + none was expected, and a negative errno-style error code otherwise. + + + + Errors + + Returned errors may indicate the following problems: + + + + -EINVAL + + The call message call is + NULL. + + Message call is not a method call message. + + + Message call is not attached to a bus. + + The error error parameter to + sd_bus_reply_method_error is not set, see + sd_bus_error_is_set3. + + + + + + -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 message returned by + sd_bus_send1 + may be returned. + + + + + + See Also + + + systemd1, + sd-bus3, + sd_bus_message_new_method_error3 + + + +