/usr/share/doc/wireshark-doc/wsug_html_chunked/lua_module_Proto.html is in wireshark-doc 1.10.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>11.10. Functions for writing dissectors</title><link rel="stylesheet" type="text/css" href="ws.css"><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="Wireshark User's Guide"><link rel="up" href="wsluarm.html" title="Chapter 11. Lua Support in Wireshark"><link rel="prev" href="lua_module_Pinfo.html" title="11.9. Obtaining packet information"><link rel="next" href="lua_module_Tree.html" title="11.11. Adding information to the dissection tree"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">11.10. Functions for writing dissectors </th></tr><tr><td width="20%" align="left"><a accesskey="p" href="lua_module_Pinfo.html">Prev</a> </td><th width="60%" align="center">Chapter 11. Lua Support in Wireshark</th><td width="20%" align="right"> <a accesskey="n" href="lua_module_Tree.html">Next</a></td></tr></table><hr></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="lua_module_Proto"></a>11.10. Functions for writing dissectors </h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="lua_class_Dissector"></a>11.10.1. Dissector</h3></div></div></div><p>A refererence to a dissector, used to call a dissector against a packet or a part of it.</p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_Dissector_get_name_"></a>11.10.1.1. Dissector.get(name)</h4></div></div></div><p>Obtains a dissector reference by name</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36074164"></a>11.10.1.1.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">name</span></dt><dd><p> The name of the dissector </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36075460"></a>11.10.1.1.2. Returns</h5></div></div></div><p>The Dissector reference</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_dissector_call_tvb__pinfo__tree_"></a>11.10.1.2. dissector:call(tvb, pinfo, tree)</h4></div></div></div><p>Calls a dissector against a given packet (or part of it)</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36119412"></a>11.10.1.2.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">tvb</span></dt><dd><p> The buffer to dissect </p></dd><dt><span class="term">pinfo</span></dt><dd><p> The packet info </p></dd><dt><span class="term">tree</span></dt><dd><p> The tree on which to add the protocol items </p></dd></dl></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_dissector___tostring__"></a>11.10.1.3. dissector:__tostring()</h4></div></div></div><p>Gets the Dissector's protocol short name</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36123268"></a>11.10.1.3.1. Returns</h5></div></div></div><p>A string of the protocol's short name</p></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="lua_class_DissectorTable"></a>11.10.2. DissectorTable</h3></div></div></div><p>A table of subdissectors of a particular protocol (e.g. TCP subdissectors like http, smtp, sip are added to table "tcp.port").
Useful to add more dissectors to a table so that they appear in the Decode As... dialog.
</p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_DissectorTable_new_tablename___uiname____type____base__"></a>11.10.2.1. DissectorTable.new(tablename, [uiname], [type], [base])</h4></div></div></div><p>Creates a new DissectorTable for your dissector's use.</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36126172"></a>11.10.2.1.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">tablename</span></dt><dd><p> The short name of the table. </p></dd><dt><span class="term">uiname (optional)</span></dt><dd><p> The name of the table in the User Interface (defaults to the name given). </p></dd><dt><span class="term">type (optional)</span></dt><dd><p> Either ftypes.UINT{8,16,24,32} or ftypes.STRING (defaults to ftypes.UINT32) </p></dd><dt><span class="term">base (optional)</span></dt><dd><p> Either base.NONE, base.DEC, base.HEX, base.OCT, base.DEC_HEX or base.HEX_DEC (defaults to base.DEC) </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36130196"></a>11.10.2.1.2. Returns</h5></div></div></div><p>The newly created DissectorTable</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_DissectorTable_get_tablename_"></a>11.10.2.2. DissectorTable.get(tablename)</h4></div></div></div><p>Obtain a reference to an existing dissector table.</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36131908"></a>11.10.2.2.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">tablename</span></dt><dd><p> The short name of the table. </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36133228"></a>11.10.2.2.2. Returns</h5></div></div></div><p>The DissectorTable</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_dissectortable_add_pattern__dissector_"></a>11.10.2.3. dissectortable:add(pattern, dissector)</h4></div></div></div><p>Add a dissector to a table.</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36134980"></a>11.10.2.3.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">pattern</span></dt><dd><p> The pattern to match (either an integer or a string depending on the table's type). </p></dd><dt><span class="term">dissector</span></dt><dd><p> The dissector to add (either an Proto or a Dissector). </p></dd></dl></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_dissectortable_remove_pattern__dissector_"></a>11.10.2.4. dissectortable:remove(pattern, dissector)</h4></div></div></div><p>Remove a dissector from a table</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36138124"></a>11.10.2.4.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">pattern</span></dt><dd><p> The pattern to match (either an integer or a string depending on the table's type). </p></dd><dt><span class="term">dissector</span></dt><dd><p> The dissector to add (either an Proto or a Dissector). </p></dd></dl></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_dissectortable_try_pattern__tvb__pinfo__tree_"></a>11.10.2.5. dissectortable:try(pattern, tvb, pinfo, tree)</h4></div></div></div><p>Try to call a dissector from a table</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36141372"></a>11.10.2.5.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">pattern</span></dt><dd><p> The pattern to be matched (either an integer or a string depending on the table's type). </p></dd><dt><span class="term">tvb</span></dt><dd><p> The buffer to dissect </p></dd><dt><span class="term">pinfo</span></dt><dd><p> The packet info </p></dd><dt><span class="term">tree</span></dt><dd><p> The tree on which to add the protocol items </p></dd></dl></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_dissectortable_get_dissector_pattern_"></a>11.10.2.6. dissectortable:get_dissector(pattern)</h4></div></div></div><p>Try to obtain a dissector from a table.</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36146164"></a>11.10.2.6.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">pattern</span></dt><dd><p> The pattern to be matched (either an integer or a string depending on the table's type). </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36147500"></a>11.10.2.6.2. Returns</h5></div></div></div><p>The dissector handle if found</p><p>nil if not found</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_dissectortable___tostring__"></a>11.10.2.7. dissectortable:__tostring()</h4></div></div></div><p>Gets some debug information about the DissectorTable</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36149420"></a>11.10.2.7.1. Returns</h5></div></div></div><p>A string of debug information about the DissectorTable</p></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="lua_class_Pref"></a>11.10.3. Pref</h3></div></div></div><p>A preference of a Protocol.</p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_Pref_bool_label__default__descr_"></a>11.10.3.1. Pref.bool(label, default, descr)</h4></div></div></div><p>Creates a boolean preference to be added to a Protocol's prefs table.</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36152116"></a>11.10.3.1.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">label</span></dt><dd><p> The Label (text in the right side of the preference input) for this preference </p></dd><dt><span class="term">default</span></dt><dd><p> The default value for this preference </p></dd><dt><span class="term">descr</span></dt><dd><p> A description of what this preference is </p></dd></dl></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_Pref_uint_label__default__descr_"></a>11.10.3.2. Pref.uint(label, default, descr)</h4></div></div></div><p>Creates an (unsigned) integer preference to be added to a Protocol's prefs table.</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36156156"></a>11.10.3.2.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">label</span></dt><dd><p> The Label (text in the right side of the preference input) for this preference </p></dd><dt><span class="term">default</span></dt><dd><p> The default value for this preference </p></dd><dt><span class="term">descr</span></dt><dd><p> A description of what this preference is </p></dd></dl></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_Pref_string_label__default__descr_"></a>11.10.3.3. Pref.string(label, default, descr)</h4></div></div></div><p>Creates a string preference to be added to a Protocol's prefs table.</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36160164"></a>11.10.3.3.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">label</span></dt><dd><p> The Label (text in the right side of the preference input) for this preference </p></dd><dt><span class="term">default</span></dt><dd><p> The default value for this preference </p></dd><dt><span class="term">descr</span></dt><dd><p> A description of what this preference is </p></dd></dl></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_Pref_enum_label__default__descr__enum__radio_"></a>11.10.3.4. Pref.enum(label, default, descr, enum, radio)</h4></div></div></div><p>Creates an enum preference to be added to a Protocol's prefs table.</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36164236"></a>11.10.3.4.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">label</span></dt><dd><p> The Label (text in the right side of the preference input) for this preference </p></dd><dt><span class="term">default</span></dt><dd><p> The default value for this preference </p></dd><dt><span class="term">descr</span></dt><dd><p> A description of what this preference is </p></dd><dt><span class="term">enum</span></dt><dd><p> A enum table </p></dd><dt><span class="term">radio</span></dt><dd><p> Radio button (true) or Combobox (false) </p></dd></dl></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_Pref_range_label__default__descr__max_"></a>11.10.3.5. Pref.range(label, default, descr, max)</h4></div></div></div><p>Creates a range preference to be added to a Protocol's prefs table.</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36169900"></a>11.10.3.5.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">label</span></dt><dd><p> The Label (text in the right side of the preference input) for this preference </p></dd><dt><span class="term">default</span></dt><dd><p> The default value for this preference, e.g., "53", "10-30", or "10-30,53,55,100-120" </p></dd><dt><span class="term">descr</span></dt><dd><p> A description of what this preference is </p></dd><dt><span class="term">max</span></dt><dd><p> The maximum value </p></dd></dl></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_Pref_statictext_label__descr_"></a>11.10.3.6. Pref.statictext(label, descr)</h4></div></div></div><p>Creates a static text preference to be added to a Protocol's prefs table.</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36174692"></a>11.10.3.6.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">label</span></dt><dd><p> The static text </p></dd><dt><span class="term">descr</span></dt><dd><p> The static text description </p></dd></dl></div></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="lua_class_Prefs"></a>11.10.4. Prefs</h3></div></div></div><p>The table of preferences of a protocol</p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_prefs___newindex_name__pref_"></a>11.10.4.1. prefs:__newindex(name, pref)</h4></div></div></div><p>Creates a new preference</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36178588"></a>11.10.4.1.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">name</span></dt><dd><p> The abbreviation of this preference </p></dd><dt><span class="term">pref</span></dt><dd><p> A valid but still unassigned Pref object </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36180716"></a>11.10.4.1.2. Errors</h5></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Unknow Pref type</p></li></ul></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_prefs___index_name_"></a>11.10.4.2. prefs:__index(name)</h4></div></div></div><p>Get the value of a preference setting</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36182524"></a>11.10.4.2.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">name</span></dt><dd><p> The abbreviation of this preference </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36183836"></a>11.10.4.2.2. Returns</h5></div></div></div><p>The current value of the preference</p></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36184644"></a>11.10.4.2.3. Errors</h5></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Unknow Pref type</p></li></ul></div></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="lua_class_Proto"></a>11.10.5. Proto</h3></div></div></div><p>A new protocol in wireshark. Protocols have more uses, the main one is to dissect
a protocol. But they can be just dummies used to register preferences for
other purposes.
</p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_Proto_new_name__desc_"></a>11.10.5.1. Proto.new(name, desc)</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36187260"></a>11.10.5.1.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">name</span></dt><dd><p> The name of the protocol </p></dd><dt><span class="term">desc</span></dt><dd><p> A Long Text description of the protocol (usually lowercase) </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36189396"></a>11.10.5.1.2. Returns</h5></div></div></div><p>The newly created protocol</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_class_attrib_proto_dissector"></a>11.10.5.2. proto.dissector</h4></div></div></div><p>The protocol's dissector, a function you define.
The called dissector function will be given three arguments of (1) a Tvb object, (2) a Pinfo object, and (3) a TreeItem object. </p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_class_attrib_proto_fields"></a>11.10.5.3. proto.fields</h4></div></div></div><p>The Fields Table of this dissector</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_class_attrib_proto_prefs"></a>11.10.5.4. proto.prefs</h4></div></div></div><p>The preferences of this dissector</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_class_attrib_proto_init"></a>11.10.5.5. proto.init</h4></div></div></div><p>The init routine of this dissector, a function you define.
The called init function is passed no arguments. </p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_class_attrib_proto_name"></a>11.10.5.6. proto.name</h4></div></div></div><p>The name given to this dissector</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_class_attrib_proto_description"></a>11.10.5.7. proto.description</h4></div></div></div><p>The description given to this dissector</p></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="lua_class_ProtoField"></a>11.10.6. ProtoField</h3></div></div></div><p>A Protocol field (to be used when adding items to the dissection tree)</p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_new_name__abbr__type___voidstring____base____mask____descr__"></a>11.10.6.1. ProtoField.new(name, abbr, type, [voidstring], [base], [mask], [descr])</h4></div></div></div><p>Creates a new field to be used in a protocol.</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36198260"></a>11.10.6.1.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">name</span></dt><dd><p> Actual name of the field (the string that appears in the tree). </p></dd><dt><span class="term">abbr</span></dt><dd><p> Filter name of the field (the string that is used in filters). </p></dd><dt><span class="term">type</span></dt><dd><p> Field Type: one of ftypes.BOOLEAN,
ftypes.UINT8, ftypes.UINT16, ftypes.UINT24, ftypes.UINT32, ftypes.UINT64, ftypes.INT8, ftypes.INT16
ftypes.INT24, ftypes.INT32, ftypes.INT64, ftypes.FLOAT, ftypes.DOUBLE, ftypes.ABSOLUTE_TIME
ftypes.RELATIVE_TIME, ftypes.STRING, ftypes.STRINGZ, ftypes.UINT_STRING, ftypes.ETHER, ftypes.BYTES
ftypes.UINT_BYTES, ftypes.IPv4, ftypes.IPv6, ftypes.IPXNET, ftypes.FRAMENUM, ftypes.PCRE, ftypes.GUID
ftypes.OID, ftypes.EUI64 </p></dd><dt><span class="term">voidstring (optional)</span></dt><dd><p> A VoidString object. </p></dd><dt><span class="term">base (optional)</span></dt><dd><p> The representation: one of base.NONE, base.DEC, base.HEX, base.OCT, base.DEC_HEX, base.HEX_DEC </p></dd><dt><span class="term">mask (optional)</span></dt><dd><p> The bitmask to be used. </p></dd><dt><span class="term">descr (optional)</span></dt><dd><p> The description of the field. </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36205092"></a>11.10.6.1.2. Returns</h5></div></div></div><p>The newly created ProtoField object</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_uint8_abbr___name____base____valuestring____mask____desc__"></a>11.10.6.2. ProtoField.uint8(abbr, [name], [base], [valuestring], [mask], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36206660"></a>11.10.6.2.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">base (optional)</span></dt><dd><p>One of base.DEC, base.HEX or base.OCT </p></dd><dt><span class="term">valuestring (optional)</span></dt><dd><p>A table containing the text that corresponds to the values </p></dd><dt><span class="term">mask (optional)</span></dt><dd><p>Integer mask of this field </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36212236"></a>11.10.6.2.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_uint16_abbr___name____base____valuestring____mask____desc__"></a>11.10.6.3. ProtoField.uint16(abbr, [name], [base], [valuestring], [mask], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36213820"></a>11.10.6.3.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">base (optional)</span></dt><dd><p>One of base.DEC, base.HEX or base.OCT </p></dd><dt><span class="term">valuestring (optional)</span></dt><dd><p>A table containing the text that corresponds to the values </p></dd><dt><span class="term">mask (optional)</span></dt><dd><p>Integer mask of this field </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36219396"></a>11.10.6.3.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_uint24_abbr___name____base____valuestring____mask____desc__"></a>11.10.6.4. ProtoField.uint24(abbr, [name], [base], [valuestring], [mask], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36220988"></a>11.10.6.4.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">base (optional)</span></dt><dd><p>One of base.DEC, base.HEX or base.OCT </p></dd><dt><span class="term">valuestring (optional)</span></dt><dd><p>A table containing the text that corresponds to the values </p></dd><dt><span class="term">mask (optional)</span></dt><dd><p>Integer mask of this field </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36226564"></a>11.10.6.4.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_uint32_abbr___name____base____valuestring____mask____desc__"></a>11.10.6.5. ProtoField.uint32(abbr, [name], [base], [valuestring], [mask], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36228156"></a>11.10.6.5.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">base (optional)</span></dt><dd><p>One of base.DEC, base.HEX or base.OCT </p></dd><dt><span class="term">valuestring (optional)</span></dt><dd><p>A table containing the text that corresponds to the values </p></dd><dt><span class="term">mask (optional)</span></dt><dd><p>Integer mask of this field </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36233732"></a>11.10.6.5.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_uint64_abbr___name____base____valuestring____mask____desc__"></a>11.10.6.6. ProtoField.uint64(abbr, [name], [base], [valuestring], [mask], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36235324"></a>11.10.6.6.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">base (optional)</span></dt><dd><p>One of base.DEC, base.HEX or base.OCT </p></dd><dt><span class="term">valuestring (optional)</span></dt><dd><p>A table containing the text that corresponds to the values </p></dd><dt><span class="term">mask (optional)</span></dt><dd><p>Integer mask of this field </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36240900"></a>11.10.6.6.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_int8_abbr___name____base____valuestring____mask____desc__"></a>11.10.6.7. ProtoField.int8(abbr, [name], [base], [valuestring], [mask], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36242484"></a>11.10.6.7.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">base (optional)</span></dt><dd><p>One of base.DEC, base.HEX or base.OCT </p></dd><dt><span class="term">valuestring (optional)</span></dt><dd><p>A table containing the text that corresponds to the values </p></dd><dt><span class="term">mask (optional)</span></dt><dd><p>Integer mask of this field </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36248060"></a>11.10.6.7.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_int16_abbr___name____base____valuestring____mask____desc__"></a>11.10.6.8. ProtoField.int16(abbr, [name], [base], [valuestring], [mask], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36249644"></a>11.10.6.8.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">base (optional)</span></dt><dd><p>One of base.DEC, base.HEX or base.OCT </p></dd><dt><span class="term">valuestring (optional)</span></dt><dd><p>A table containing the text that corresponds to the values </p></dd><dt><span class="term">mask (optional)</span></dt><dd><p>Integer mask of this field </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36255220"></a>11.10.6.8.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_int24_abbr___name____base____valuestring____mask____desc__"></a>11.10.6.9. ProtoField.int24(abbr, [name], [base], [valuestring], [mask], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36256804"></a>11.10.6.9.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">base (optional)</span></dt><dd><p>One of base.DEC, base.HEX or base.OCT </p></dd><dt><span class="term">valuestring (optional)</span></dt><dd><p>A table containing the text that corresponds to the values </p></dd><dt><span class="term">mask (optional)</span></dt><dd><p>Integer mask of this field </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36262380"></a>11.10.6.9.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_int32_abbr___name____base____valuestring____mask____desc__"></a>11.10.6.10. ProtoField.int32(abbr, [name], [base], [valuestring], [mask], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36263964"></a>11.10.6.10.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">base (optional)</span></dt><dd><p>One of base.DEC, base.HEX or base.OCT </p></dd><dt><span class="term">valuestring (optional)</span></dt><dd><p>A table containing the text that corresponds to the values </p></dd><dt><span class="term">mask (optional)</span></dt><dd><p>Integer mask of this field </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36269540"></a>11.10.6.10.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_int64_abbr___name____base____valuestring____mask____desc__"></a>11.10.6.11. ProtoField.int64(abbr, [name], [base], [valuestring], [mask], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36271124"></a>11.10.6.11.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">base (optional)</span></dt><dd><p>One of base.DEC, base.HEX or base.OCT </p></dd><dt><span class="term">valuestring (optional)</span></dt><dd><p>A table containing the text that corresponds to the values </p></dd><dt><span class="term">mask (optional)</span></dt><dd><p>Integer mask of this field </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36276700"></a>11.10.6.11.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_framenum_abbr___name____base____valuestring____mask____desc__"></a>11.10.6.12. ProtoField.framenum(abbr, [name], [base], [valuestring], [mask], [desc])</h4></div></div></div><p>A frame number (for hyperlinks between frames)</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36278532"></a>11.10.6.12.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">base (optional)</span></dt><dd><p>One of base.DEC, base.HEX or base.OCT </p></dd><dt><span class="term">valuestring (optional)</span></dt><dd><p>A table containing the text that corresponds to the values </p></dd><dt><span class="term">mask (optional)</span></dt><dd><p>Integer mask of this field </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36284108"></a>11.10.6.12.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_bool_abbr___name____display____string____mask____desc__"></a>11.10.6.13. ProtoField.bool(abbr, [name], [display], [string], [mask], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36285684"></a>11.10.6.13.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">display (optional)</span></dt><dd><p>how wide the parent bitfield is (base.NONE is used for NULL-value) </p></dd><dt><span class="term">string (optional)</span></dt><dd><p>A table containing the text that corresponds to the values </p></dd><dt><span class="term">mask (optional)</span></dt><dd><p>Integer mask of this field </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36291212"></a>11.10.6.13.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_absolute_time_abbr___name____base____desc__"></a>11.10.6.14. ProtoField.absolute_time(abbr, [name], [base], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36292820"></a>11.10.6.14.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">base (optional)</span></dt><dd><p>One of base.LOCAL, base.UTC or base.DOY_UTC </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36296636"></a>11.10.6.14.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_relative_time_abbr___name____desc__"></a>11.10.6.15. ProtoField.relative_time(abbr, [name], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36298236"></a>11.10.6.15.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36301204"></a>11.10.6.15.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_ipv4_abbr___name____desc__"></a>11.10.6.16. ProtoField.ipv4(abbr, [name], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36302740"></a>11.10.6.16.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36305756"></a>11.10.6.16.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_ipv6_abbr___name____desc__"></a>11.10.6.17. ProtoField.ipv6(abbr, [name], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36307284"></a>11.10.6.17.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36310300"></a>11.10.6.17.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_ether_abbr___name____desc__"></a>11.10.6.18. ProtoField.ether(abbr, [name], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36311828"></a>11.10.6.18.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36314844"></a>11.10.6.18.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_float_abbr___name____desc__"></a>11.10.6.19. ProtoField.float(abbr, [name], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36316372"></a>11.10.6.19.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36319388"></a>11.10.6.19.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_double_abbr___name____desc__"></a>11.10.6.20. ProtoField.double(abbr, [name], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36320916"></a>11.10.6.20.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36323932"></a>11.10.6.20.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_string_abbr___name____desc__"></a>11.10.6.21. ProtoField.string(abbr, [name], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36325468"></a>11.10.6.21.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36328484"></a>11.10.6.21.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_stringz_abbr___name____desc__"></a>11.10.6.22. ProtoField.stringz(abbr, [name], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36330020"></a>11.10.6.22.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36333036"></a>11.10.6.22.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_bytes_abbr___name____desc__"></a>11.10.6.23. ProtoField.bytes(abbr, [name], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36334572"></a>11.10.6.23.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36337588"></a>11.10.6.23.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_ubytes_abbr___name____desc__"></a>11.10.6.24. ProtoField.ubytes(abbr, [name], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36339116"></a>11.10.6.24.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36342132"></a>11.10.6.24.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_guid_abbr___name____desc__"></a>11.10.6.25. ProtoField.guid(abbr, [name], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36343668"></a>11.10.6.25.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36346684"></a>11.10.6.25.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_oid_abbr___name____desc__"></a>11.10.6.26. ProtoField.oid(abbr, [name], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36348204"></a>11.10.6.26.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36351220"></a>11.10.6.26.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProtoField_bool_abbr___name____desc__"></a>11.10.6.27. ProtoField.bool(abbr, [name], [desc])</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36352748"></a>11.10.6.27.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">abbr</span></dt><dd><p>Abbreviated name of the field (the string used in filters) </p></dd><dt><span class="term">name (optional)</span></dt><dd><p>Actual name of the field (the string that appears in the tree) </p></dd><dt><span class="term">desc (optional)</span></dt><dd><p>Description of the field </p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36355764"></a>11.10.6.27.2. Returns</h5></div></div></div><p>A protofield item to be added to a ProtoFieldArray</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_protofield___tostring__"></a>11.10.6.28. protofield:__tostring()</h4></div></div></div><p>Returns a string with info about a protofield (for debugging purposes)</p></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="non_method_functions_Proto"></a>11.10.7. Non Method Functions</h3></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_register_postdissector_proto_"></a>11.10.7.1. register_postdissector(proto)</h4></div></div></div><p>Make a protocol (with a dissector) a postdissector. It will be called for every frame after dissection</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a name="idp36359276"></a>11.10.7.1.1. Arguments</h5></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">proto</span></dt><dd><p> the protocol to be used as postdissector </p></dd></dl></div></div></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="lua_module_Pinfo.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="wsluarm.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="lua_module_Tree.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">11.9. Obtaining packet information </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 11.11. Adding information to the dissection tree </td></tr></table></div></body></html>
|