docs: Explain the FT_FRAMENUM use of the strings field

Add a section about FRAMENUM_TYPE to the 'strings' field
section of README.dissector
This commit is contained in:
John Thacker 2023-01-16 21:53:37 -05:00 committed by Alexis La Goutte
parent d851134d89
commit ffdf332f24
1 changed files with 16 additions and 0 deletions

View File

@ -1247,6 +1247,22 @@ in tfs.h, included via packet.h.
Custom fields (BASE_CUSTOM) should use CF_FUNC(&custom_format_func) for the
'strings' field.
-- Frame numbers
FT_FRAMENUMs can use the 'strings' field to indicate their purpose by
setting the field to 'FRAMENUM_TYPE(x)', where x is one of the values of
the ft_framenum_type enum:
The packet list uses the value to determine the related packet symbol to draw.
Note that 'strings' field NULL is equal to FRAMENUM_TYPE(FT_FRAMENUM_NONE).
-- Note to plugin authors
Data cannot get exported from DLLs. For this reason plugin authors cannot use
existing fieldconvert strings (e.g. from existing dissectors or those from