diff options
| author | Michael Mann <mmann78@netscape.net> | 2015-11-25 21:40:43 -0500 |
|---|---|---|
| committer | Alexis La Goutte <alexis.lagoutte@gmail.com> | 2015-11-26 06:31:02 +0000 |
| commit | 2cf37ea0a09771e59353368ad187e9ad647e3d90 (patch) | |
| tree | 22dee1308a51dd970b9bb4c7ba34a689fbb2e8c4 /doc | |
| parent | 98a50d8513b5af14fbeb6548c60b143a705b5bd0 (diff) | |
| download | wireshark-2cf37ea0a09771e59353368ad187e9ad647e3d90.tar.gz | |
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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.dissector | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/README.dissector b/doc/README.dissector index 55351f696d..0adf1ca951 100644 --- a/doc/README.dissector +++ b/doc/README.dissector @@ -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); |