summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorUli Heilmeier <uh@heilmeier.eu>2016-07-30 11:36:15 +0200
committerMichael Mann <mmann78@netscape.net>2016-07-30 16:21:11 +0000
commit62ea2370f8c84964249771590357f2153044a43a (patch)
tree4843e2bfdc7efcfea6db758212f3d36fe24d7d92 /doc
parente3d78be0b47537b61fd431e15e7c4ec2b4b4a5b6 (diff)
downloadwireshark-62ea2370f8c84964249771590357f2153044a43a.tar.gz
README.dissector: Add proto_tree_add_bitmask_with_flags()
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>
Diffstat (limited to 'doc')
-rw-r--r--doc/README.dissector9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/README.dissector b/doc/README.dissector
index 94fa462d1c..18eda283d4 100644
--- a/doc/README.dissector
+++ b/doc/README.dissector
@@ -1423,6 +1423,10 @@ protocol or field labels to the proto_tree:
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);
@@ -1971,6 +1975,11 @@ There are the following flags defined:
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).