From: Simon McVittie Date: Fri, 10 Jun 2011 09:39:10 +0000 (+0100) Subject: find_field_for_modification: document where the readers are left pointing X-Git-Tag: dbus-1.5.10~62 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=de9b34d933fab78045e695d3e6107efc6757ca53;p=thirdparty%2Fdbus.git find_field_for_modification: document where the readers are left pointing Bug: https://bugs.freedesktop.org/show_bug.cgi?id=38285 Reviewed-by: Cosimo Alfarano --- diff --git a/dbus/dbus-marshal-header.c b/dbus/dbus-marshal-header.c index 4a763fbaa..88887a82a 100644 --- a/dbus/dbus-marshal-header.c +++ b/dbus/dbus-marshal-header.c @@ -1200,6 +1200,19 @@ _dbus_header_update_lengths (DBusHeader *header, _dbus_header_get_byte_order (header)); } +/** + * Try to find the given field. + * + * @param header the header + * @param field the field code + * @param reader a type reader; on success this is left pointing at the struct + * (uv) for the field, while on failure it is left pointing into empty space + * at the end of the header fields + * @param realign_root another type reader; on success or failure it is left + * pointing to the beginning of the array of fields (i.e. the thing that might + * need realigning) + * @returns #TRUE on success + */ static dbus_bool_t find_field_for_modification (DBusHeader *header, int field,