aboutsummaryrefslogtreecommitdiffstats
path: root/doc/README.dissector
diff options
context:
space:
mode:
authorGuy Harris <guy@alum.mit.edu>2017-01-09 22:18:49 -0800
committerGuy Harris <guy@alum.mit.edu>2017-01-10 06:19:37 +0000
commit7cd6906056922e4b8f68f1216d94eaa0809896fe (patch)
tree5a8c793f188ddda7f36a50369d00ff0de8f563e5 /doc/README.dissector
parent2a3b2360e15d49defde55240a5c1e171c7cade89 (diff)
Rename tvb_new_subset() to tvb_new_subset_length_caplen().
This emphasizes that there is no such thing as *the* routine to construct a subset tvbuff; you need to choose one of tvb_new_subset_remaining() (if you want a new tvbuff that contains everything past a certain point in an existing tvbuff), tvb_new_subset_length() (if you want a subset that contains everything past a certain point, for some number of bytes, in an existing tvbuff), and tvb_new_subset_length_caplen() (for all other cases). Many of the calls to tvb_new_subset_length_caplen() should really be calling one of the other routines; that's the next step. (This also makes it easier to find the calls that need fixing.) Change-Id: Ieb3d676d8cda535451c119487d7cd3b559221f2b Reviewed-on: https://code.wireshark.org/review/19597 Reviewed-by: Guy Harris <guy@alum.mit.edu>
Diffstat (limited to 'doc/README.dissector')
-rw-r--r--doc/README.dissector2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/README.dissector b/doc/README.dissector
index 39600c515e..3a722cb87f 100644
--- a/doc/README.dissector
+++ b/doc/README.dissector
@@ -2225,7 +2225,7 @@ that are relevant to the next dissector).
The syntax for creating a new TVBUFF_SUBSET is:
-next_tvb = tvb_new_subset(tvb, offset, length, reported_length)
+next_tvb = tvb_new_subset_length_caplen(tvb, offset, length, reported_length)
or, in the common case where it should just run to the end of the packet,