sd_bus_message_verify_type(3) — Linux manual page

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

SD_BUS_M...IFY_TYPE(3) sd_bus_message_verify_type SD_BUS_M...IFY_TYPE(3)

NAME         top

       sd_bus_message_verify_type - Check if the message has specified
       type at the current location

SYNOPSIS         top

       #include <systemd/sd-bus.h>

       int sd_bus_message_verify_type(sd_bus_message *m, char type,
                                      const char* contents);

DESCRIPTION         top

       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_append(1). 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         top

       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 constraints listed above.

       -EPERM
           Message m is not sealed.

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
       started.

SEE ALSO         top

       systemd(1), sd-bus(3), sd_bus_message_append(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 2024-06-14.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2024-06-13.)  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
       [email protected]

systemd 257~devel                                 SD_BUS_M...IFY_TYPE(3)

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