aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAnders Broman <anders.broman@ericsson.com>2012-02-29 20:38:39 +0000
committerAnders Broman <anders.broman@ericsson.com>2012-02-29 20:38:39 +0000
commit872c2094c48230c9b53de8c5506de43db5062a34 (patch)
tree491ea8b43c6475397fe9b31f4659c0a48b5b5e01 /doc
parent380f3f54a7e805c0c7e5bad38cd298973c106070 (diff)
From Mike Morrin:
The attached patches add the uses proto_tree_add_split_bits_ret_val() proto_tree_add_split_bits_crumb() https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=6885 svn path=/trunk/; revision=41249
Diffstat (limited to 'doc')
-rw-r--r--doc/README.developer18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/README.developer b/doc/README.developer
index e0a0df7d2e..89ea8344c5 100644
--- a/doc/README.developer
+++ b/doc/README.developer
@@ -2318,6 +2318,14 @@ protocol or field labels to the proto_tree:
proto_tree_add_bitmask_text(tree, tvb, offset, len, name, fallback,
ett, fields, little_endian, flags);
+ proto_item *
+ proto_tree_add_split_bits_ret_val(tree, hf_index, tvb, bit_offset,
+ crumb_spec, return_value);
+
+ void
+ proto_tree_add_split_bits_crumb(tree, hf_index, tvb, bit_offset,
+ crumb_spec, crumb_index);
+
The 'tree' argument is the tree to which the item is to be added. The
'tvb' argument is the tvbuff from which the item's value is being
extracted; the 'start' argument is the offset from the beginning of that
@@ -2672,6 +2680,16 @@ proto_tree_add_bits_ret_val()
-----------------------------
Works in the same way but also returns the value of the read bits.
+proto_tree_add_split_bits_ret_val()
+-----------------------------------
+Similar, but is used for items that are made of 2 or more smaller sets of bits (crumbs)
+which are not contiguous, but are concatenated to form the actual value. The size of
+the crumbs and the order of assembly are specified in an array of crumb_spec structures.
+
+proto_tree_add_split_bits_crumb()
+---------------------------------
+Helper function for the above, to add text for each crumb as it is encountered.
+
proto_tree_add_bitmask() and proto_tree_add_bitmask_text()
----------------------------------------------------------
This function provides an easy to use and convenient helper function