aboutsummaryrefslogtreecommitdiffstats
path: root/epan
diff options
context:
space:
mode:
authorGuy Harris <gharris@sonic.net>2021-06-16 00:43:07 -0700
committerGuy Harris <gharris@sonic.net>2021-06-16 00:43:07 -0700
commit6c043d5c73e3bdbb84f988a82ebdfc18d77489b9 (patch)
tree7414a1a0edf6e38cbdc54d9aebe4290794bd1536 /epan
parentbd9ceaebef86a30f5f45a8887fd01883dd0d1993 (diff)
wslua_tvb: fix documentation for reported_length_remaining().
In the past, tvb_reported_length_remaining(), and thus Tvb:reported_length_remaining(), may have returned -1 if the offset was invalid. That's no longer the case; the former returns 0, and, as the latter just returns the former's return value, that's true of the latter as well.
Diffstat (limited to 'epan')
-rw-r--r--epan/wslua/wslua_tvb.c2
1 files changed, 1 insertions, 1 deletions
diff --git a/epan/wslua/wslua_tvb.c b/epan/wslua/wslua_tvb.c
index 56f57e6a43..a2f253ef32 100644
--- a/epan/wslua/wslua_tvb.c
+++ b/epan/wslua/wslua_tvb.c
@@ -157,7 +157,7 @@ WSLUA_METHOD Tvb_len(lua_State* L) {
}
WSLUA_METHOD Tvb_reported_length_remaining(lua_State* L) {
- /* Obtain the reported (not captured) length of packet data to end of a <<lua_class_Tvb,`Tvb`>> or -1 if the
+ /* Obtain the reported (not captured) length of packet data to end of a <<lua_class_Tvb,`Tvb`>> or 0 if the
offset is beyond the end of the <<lua_class_Tvb,`Tvb`>>. */
#define Tvb_reported_length_remaining_OFFSET 2 /* offset */
Tvb tvb = checkTvb(L,1);