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.
This commit is contained in:
Guy Harris 2021-06-16 00:43:07 -07:00
parent bd9ceaebef
commit 6c043d5c73
1 changed files with 1 additions and 1 deletions

View File

@ -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);