From 2c48865bd005591113a49a3914172473e0f9618f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Fri, 27 Jul 2018 16:33:02 +0200 Subject: [PATCH] man: add sd_bus_message_verify_type(3) --- man/rules/meson.build | 1 + man/sd-bus.xml | 1 + man/sd_bus_message_verify_type.xml | 99 ++++++++++++++++++++++++++++++ 3 files changed, 101 insertions(+) create mode 100644 man/sd_bus_message_verify_type.xml diff --git a/man/rules/meson.build b/man/rules/meson.build index 5be98947a1..acd8710ff0 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -251,6 +251,7 @@ manpages = [ 'sd_bus_message_get_sender', 'sd_bus_message_set_sender'], ''], + ['sd_bus_message_verify_type', '3', [], ''], ['sd_bus_negotiate_fds', '3', ['sd_bus_negotiate_creds', 'sd_bus_negotiate_timestamp'], diff --git a/man/sd-bus.xml b/man/sd-bus.xml index 0e381cc9d8..dc358e817a 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -68,6 +68,7 @@ sd_bus_message_read_basic3, sd_bus_message_read3, sd_bus_message_set_destination3, +sd_bus_message_verify_type3, sd_bus_negotiate_fds3, sd_bus_new3, sd_bus_path_encode3, diff --git a/man/sd_bus_message_verify_type.xml b/man/sd_bus_message_verify_type.xml new file mode 100644 index 0000000000..fcb9f19e15 --- /dev/null +++ b/man/sd_bus_message_verify_type.xml @@ -0,0 +1,99 @@ + + + + + + + sd_bus_message_verify_type + systemd + + + + sd_bus_message_verify_type + 3 + + + + sd_bus_message_verify_type + + Check if the message has specified type at the current location + + + + + #include <systemd/sd-bus.h> + + + int sd_bus_message_verify_type + sd_bus_message *m + char type + const char* contents + + + + + + Description + + sd_bus_message_verify_type() checks if the complete type at the + current location in the message m matches the specified + type and contents. If non-zero, parameter + type must be one of the types specified in + sd_bus_message_append1. + If non-null, parameter contents must be a valid sequence of complete + types. If both type and contents are specified + type must be a container type. + + If type is specified, the type in the message must match. If + contents is specified, the type in the message must be a container type + with this signature. + + + + Return Value + + On success, this call returns true if the type matches and zero if not (the message + m contains different data or the end of the message has been reached). On + failure, it returns a negative errno-style error code. + + + + Errors + + Returned errors may indicate the following problems: + + + + + -EINVAL + + m or both type and + contents are NULL. + + Arguments do not satisfy other contraints listed above. + + + + + -EPERM + + Message m is not sealed. + + + + + + + + + See Also + + + systemd1, + sd-bus3, + sd_bus_message_append3 + + + +