diff options
author | Guy Harris <guy@alum.mit.edu> | 2017-04-18 15:27:28 -0700 |
---|---|---|
committer | Guy Harris <guy@alum.mit.edu> | 2017-04-18 22:28:07 +0000 |
commit | 913f9fb35335acd30aa231b00b23fd8f0dc379fb (patch) | |
tree | 01c6efe0aa401ea0c83507083cec853456ddcc77 /doc/README.dissector | |
parent | c9088466253f53bb29602810b7f4ad5fca627f92 (diff) |
Rename BASE_VALS_NO_UNKNOWN to BASE_SPECIAL_VALS.
It makes it a bit clearer what its purpose is - to allow a value_string
to be used for numeric rather than enumerated fields, giving certain
values of the field a special meaning.
Change the explanation in the documentation to match as well.
Change-Id: Id07b22eee996b79ea5f3473928d29adcabe09bf3
Reviewed-on: https://code.wireshark.org/review/21209
Reviewed-by: Guy Harris <guy@alum.mit.edu>
Diffstat (limited to 'doc/README.dissector')
-rw-r--r-- | doc/README.dissector | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/doc/README.dissector b/doc/README.dissector index 04e6177ac8..1f327a9995 100644 --- a/doc/README.dissector +++ b/doc/README.dissector @@ -117,7 +117,7 @@ FIELDDISPLAY --For FT_UINT{8,16,24,32,40,48,56,64} and BASE_DEC, BASE_HEX, BASE_OCT, BASE_DEC_HEX, BASE_HEX_DEC, BASE_CUSTOM, or BASE_NONE, possibly ORed with BASE_RANGE_STRING, BASE_EXT_STRING, BASE_VAL64_STRING, - BASE_ALLOW_ZERO, BASE_UNIT_STRING, BASE_VALS_NO_UNKNOWN or + BASE_ALLOW_ZERO, BASE_UNIT_STRING, BASE_SPECIAL_VALS or BASE_NO_DISPLAY_VALUE BASE_NONE may be used with a non-NULL FIELDCONVERT when the @@ -950,11 +950,12 @@ indicate the end of the array). The 'strings' field would be set to If the field has a numeric rather than an enumerated type, the 'strings' field would be set to NULL. -If BASE_VALS_NO_UNKNOWN is also applied to the display bitmask, then if -the numeric value of a field doesn't match any values in the value_string -then just the numeric value is displayed (i.e. no "Unknown"). This is intended -for value_strings that may only have a single value or maybe an enumeration -for mix/max values of a field. + +If BASE_SPECIAL_VALS is also applied to the display bitmask, then if the +numeric value of a field doesn't match any values in the value_string +then just the numeric value is displayed (i.e. no "Unknown"). This is +intended for use when the value_string only gives special names for +certain field values and values not in the value_string are expected. -- Extended value strings You can also use an extended version of the value_string for faster lookups. @@ -999,7 +1000,8 @@ val64_strings are like value_strings, except that the integer type used is a guint64 (instead of guint32). Instead of using the VALS() macro for the 'strings' field in the header_field_info struct array, 'VALS64()' is used. -BASE_VALS_NO_UNKNOWN can also be used for val64_string. + +BASE_SPECIAL_VALS can also be used for val64_string. -- Unit string Some integer fields, of type FT_UINT* and float fields, of type FT_FLOAT |