Document tvb_get_guintXXX and tvb_get_ieee_XXX

Change-Id: I498c0ca39befa0c0117ee78c23714bf7af193ce9
Reviewed-on: https://code.wireshark.org/review/12164
Petri-Dish: Michael Mann <mmann78@netscape.net>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
This commit is contained in:
Michael Mann 2015-11-25 21:40:43 -05:00 committed by Alexis La Goutte
parent 98a50d8513
commit 2cf37ea0a0
1 changed files with 27 additions and 0 deletions

View File

@ -240,6 +240,33 @@ double-precision IEEE floating-point numbers:
gfloat tvb_get_letohieee_float(tvbuff_t *tvb, const gint offset);
gdouble tvb_get_letohieee_double(tvbuff_t *tvb, const gint offset);
Encoding-to_host-order accessors for 16-bit integers (guint16),
24-bit integers, 32-bit integers (guint32), 40-bit integers, 48-bit
integers, 56-bit integers, and 64-bit integers (guint64):
guint16 tvb_get_guint16(tvbuff_t *tvb, const gint offset, const guint encoding);
guint32 tvb_get_guint24(tvbuff_t *tvb, const gint offset, const guint encoding);
guint32 tvb_get_guint32(tvbuff_t *tvb, const gint offset, const guint encoding);
guint64 tvb_get_guint40(tvbuff_t *tvb, const gint offset, const guint encoding);
gint64 tvb_get_gint40(tvbuff_t *tvb, const gint offset, const guint encoding);
guint64 tvb_get_guint48(tvbuff_t *tvb, const gint offset, const guint encoding);
gint64 tvb_get_gint48(tvbuff_t *tvb, const gint offset, const guint encoding);
guint64 tvb_get_guint56(tvbuff_t *tvb, const gint offset, const guint encoding);
gint64 tvb_get_gint56(tvbuff_t *tvb, const gint offset, const guint encoding);
guint64 tvb_get_guint64(tvbuff_t *tvb, const gint offset, const guint encoding);
"encoding" should be ENC_BIG_ENDIAN for Network-to-host-order and ENC_LITTLE_ENDIAN
for Little-Endian-to-host-order.
Endian-to-host-order accessors for single-precision and
double-precision IEEE floating-point numbers:
gfloat tvb_get_ieee_float(tvbuff_t *tvb, const gint offset, const guint encoding);
gdouble tvb_get_ieee_double(tvbuff_t *tvb, const gint offset, const guint encoding);
Just as above, "encoding" should be ENC_BIG_ENDIAN for Network-to-host-order and
ENC_LITTLE_ENDIAN for Little-Endian-to-host-order.
Accessors for IPv4 and IPv6 addresses:
guint32 tvb_get_ipv4(tvbuff_t *tvb, const gint offset);