Extend README with proto_tree_add_bitmask_with_flags() function.
Change-Id: Ia984080eda77ab93b063771d625bc45b5b0fc6d2
Reviewed-on: https://code.wireshark.org/review/16785
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Reviewed-by: Michael Mann <mmann78@netscape.net>
proto_tree_add_bitmask_text(tree, tvb, offset, len, name, fallback,
ett, fields, encoding, flags);
proto_tree_add_bitmask_text(tree, tvb, offset, len, name, fallback,
ett, fields, encoding, flags);
+ proto_item *
+ proto_tree_add_bitmask_with_flags(tree, tvb, offset, hf_hdr, ett,
+ fields, encoding, flags);
+
proto_item*
proto_tree_add_bits_item(tree, id, tvb, bit_offset, no_of_bits,
encoding);
proto_item*
proto_tree_add_bits_item(tree, id, tvb, bit_offset, no_of_bits,
encoding);
BMT_NO_FALSE - boolean flags are only added to the title if they are set.
BMT_NO_TFS - only add flag name to the title, do not use true_false_string
BMT_NO_FALSE - boolean flags are only added to the title if they are set.
BMT_NO_TFS - only add flag name to the title, do not use true_false_string
+The proto_tree_add_bitmask_with_flags() function is an extended version
+of the proto_tree_add_bitmask() function. It allows using flags to specify
+which fields will affect the top-level title. The flags are the
+same BMT_NO_* flags as used in the proto_tree_add_bitmask_text() function.
+
The proto_tree_add_bitmask() behavior can be obtained by providing
both 'name' and 'fallback' arguments as NULL, and a flags of
(BMT_NO_FALSE|BMT_NO_TFS).
The proto_tree_add_bitmask() behavior can be obtained by providing
both 'name' and 'fallback' arguments as NULL, and a flags of
(BMT_NO_FALSE|BMT_NO_TFS).