sd_bus_message_append man page

sd_bus_message_append — Attach fields to a D-Bus message based on a type string


#include <systemd/sd-bus.h>

int sd_bus_message_append(sd_bus_message *m, const char *types, ...);


The sd_bus_message_append() function appends a sequence of fields to the D-Bus message object m. The type string types describes the types of the field arguments that follow. For each type specified in the type string one or more arguments need to be specified, in the same order as declared in the type string.

The type string is composed of the elements shown in the table below. It contains zero or more single "complete types". Each complete type may be one of the basic types or a fully described container type. A container type may be a structure with the contained types, a variant, an array with its element type, or a dictionary entry with the contained types. The type string is NUL-terminated.

In case of a basic type, one argument of the corresponding type is expected.

A structure is denoted by a sequence of complete types between ( and ). This sequence cannot be empty — it must contain at least one type. Arguments corresponding to this nested sequence follow the same rules as if they were not nested.

A variant is denoted by v. Corresponding arguments must begin with a type string denoting a complete type, and following that, arguments corresponding to the specified type.

An array is denoted by a followed by a complete type. Corresponding arguments must begin with the number of entries in the array, followed by the entries themselves, matching the element type of the array.

A dictionary is an array of dictionary entries, denoted by a followed by a pair of complete types between { and }. The first of those types must be a basic type. Corresponding arguments must begin with the number of dictionary entries, followed by a pair of values for each entry matching the element type of the dictionary entries.

For further details on the D-Bus type system, please consult the D-Bus Specification.

Table 1. Item type specifiers

SpecifierConstantDescriptionSizeExpected C Type
ySD_BUS_TYPE_BYTEunsigned integer1 byteuint8_t
bSD_BUS_TYPE_BOOLEANboolean4 bytesint
nSD_BUS_TYPE_INT16signed integer2 bytesint16_t
qSD_BUS_TYPE_UINT16unsigned integer2 bytesuint16_t
iSD_BUS_TYPE_INT32signed integer4 bytesint32_t
uSD_BUS_TYPE_UINT32unsigned integer4 bytesuint32_t
xSD_BUS_TYPE_INT64signed integer8 bytesint64_t
tSD_BUS_TYPE_UINT64unsigned integer8 bytesuint64_t
dSD_BUS_TYPE_DOUBLEfloating-point8 bytesdouble
sSD_BUS_TYPE_STRINGUnicode stringvariablechar[]
oSD_BUS_TYPE_OBJECT_PATHobject pathvariablechar[]
hSD_BUS_TYPE_UNIX_FDUNIX file descriptor4 bytesint
aSD_BUS_TYPE_ARRAYarraydetermined by array type and sizeint, followed by array contents
vSD_BUS_TYPE_VARIANTvariantdetermined by the type argumentsignature string, followed by variant contents
(SD_BUS_TYPE_STRUCT_BEGINarray startdetermined by the nested typesstructure contents
{SD_BUS_TYPE_DICT_ENTRY_BEGINdictionary entry startdetermined by the nested typesdictionary contents
}SD_BUS_TYPE_DICT_ENTRY_ENDdictionary entry end

Types String Grammar

types ::= complete_type*
complete_type ::= basic_type | variant | structure | array | dictionary
basic_type ::= "y" | "n" | "q" | "u" | "i" | "x" | "t" | "d" |
               "b" | "h" |
               "s" | "o" | "g"
variant ::= "v"
structure ::= "(" complete_type+ ")"
array ::= "a" complete_type
dictionary ::= "a" "{" basic_type complete_type "}"


Append a single basic type (the string a string):

sd_bus_message *m;
sd_bus_message_append(m, "s", "a string");

Append all types of integers:

uint8_t y = 1;
int16_t n = 2;
uint16_t q = 3;
int32_t i = 4;
uint32_t u = 5;
int32_t x = 6;
uint32_t t = 7;
double d = 8.0;
sd_bus_message_append(m, "ynqiuxtd", y, n, q, i, u, x, t, d);

Append a structure composed of a string and a D-Bus path:

sd_bus_message_append(m, "(so)", "a string", "/a/path");

Append an array of UNIX file descriptors:

sd_bus_message_append(m, "ah", 3, STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO);

Append a variant, with the real type "g" (signature), and value "sdbusisgood":

sd_bus_message_append(m, "v", "g", "sdbusisgood");

Append a dictionary containing the mapping {1=>"a", 2=>"b", 3=>""}:

sd_bus_message_append(m, "a{is}", 3, 1, "a", 2, "b", 3, NULL);

Return Value

On success, this call returns 0 or a positive integer. On failure, this call returns a negative errno-style error code.


Returned errors may indicate the following problems:

Specified parameter is invalid.
Message has been sealed.
Message is in invalid state.
Message cannot be appended to.
Memory allocation failed.


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

See Also

systemd(1), sd-bus(3), sd_bus_message_append_basic(3), sd_bus_message_append_array(3)

Referenced By

sd-bus(3), sd_bus_message_append_array(3), sd_bus_message_append_basic(3), sd_bus_message_append_strv(3), systemd.directives(7), systemd.index(7).

Explore man page connections for sd_bus_message_append(3).