Document the proto_tree_add_XXX_format_value() routines.

svn path=/trunk/; revision=17318
This commit is contained in:
Guy Harris 2006-02-16 11:51:02 +00:00
parent 35e1e1abe4
commit 13a8667b08
1 changed files with 81 additions and 0 deletions

View File

@ -1622,6 +1622,10 @@ protocol or field labels to the proto_tree:
proto_tree_add_bytes_format(tree, id, tvb, start, length, start_ptr,
format, ...);
proto_item *
proto_tree_add_bytes_format_value(tree, id, tvb, start, length,
start_ptr, format, ...);
proto_item *
proto_tree_add_time(tree, id, tvb, start, length, value_ptr);
@ -1632,6 +1636,10 @@ protocol or field labels to the proto_tree:
proto_tree_add_time_format(tree, id, tvb, start, length, value_ptr,
format, ...);
proto_item *
proto_tree_add_time_format_value(tree, id, tvb, start, length,
value_ptr, format, ...);
proto_item *
proto_tree_add_ipxnet(tree, id, tvb, start, length, value);
@ -1642,6 +1650,10 @@ protocol or field labels to the proto_tree:
proto_tree_add_ipxnet_format(tree, id, tvb, start, length, value,
format, ...);
proto_item *
proto_tree_add_ipxnet_format_value(tree, id, tvb, start, length,
value, format, ...);
proto_item *
proto_tree_add_ipv4(tree, id, tvb, start, length, value);
@ -1652,6 +1664,10 @@ protocol or field labels to the proto_tree:
proto_tree_add_ipv4_format(tree, id, tvb, start, length, value,
format, ...);
proto_item *
proto_tree_add_ipv4_format_value(tree, id, tvb, start, length,
value, format, ...);
proto_item *
proto_tree_add_ipv6(tree, id, tvb, start, length, value_ptr);
@ -1662,6 +1678,10 @@ protocol or field labels to the proto_tree:
proto_tree_add_ipv6_format(tree, id, tvb, start, length, value_ptr,
format, ...);
proto_item *
proto_tree_add_ipv6_format_value(tree, id, tvb, start, length,
value_ptr, format, ...);
proto_item *
proto_tree_add_ether(tree, id, tvb, start, length, value_ptr);
@ -1672,6 +1692,10 @@ protocol or field labels to the proto_tree:
proto_tree_add_ether_format(tree, id, tvb, start, length, value_ptr,
format, ...);
proto_item *
proto_tree_add_ether_format_value(tree, id, tvb, start, length,
value_ptr, format, ...);
proto_item *
proto_tree_add_string(tree, id, tvb, start, length, value_ptr);
@ -1682,6 +1706,10 @@ protocol or field labels to the proto_tree:
proto_tree_add_string_format(tree, id, tvb, start, length, value_ptr,
format, ...);
proto_item *
proto_tree_add_string_format_value(tree, id, tvb, start, length,
value_ptr, format, ...);
proto_item *
proto_tree_add_boolean(tree, id, tvb, start, length, value);
@ -1692,6 +1720,10 @@ protocol or field labels to the proto_tree:
proto_tree_add_boolean_format(tree, id, tvb, start, length, value,
format, ...);
proto_item *
proto_tree_add_boolean_format_value(tree, id, tvb, start, length,
value, format, ...);
proto_item *
proto_tree_add_float(tree, id, tvb, start, length, value);
@ -1702,6 +1734,10 @@ protocol or field labels to the proto_tree:
proto_tree_add_float_format(tree, id, tvb, start, length, value,
format, ...);
proto_item *
proto_tree_add_float_format_value(tree, id, tvb, start, length,
value, format, ...);
proto_item *
proto_tree_add_double(tree, id, tvb, start, length, value);
@ -1712,6 +1748,10 @@ protocol or field labels to the proto_tree:
proto_tree_add_double_format(tree, id, tvb, start, length, value,
format, ...);
proto_item *
proto_tree_add_double_format_value(tree, id, tvb, start, length,
value, format, ...);
proto_item *
proto_tree_add_uint(tree, id, tvb, start, length, value);
@ -1722,6 +1762,10 @@ protocol or field labels to the proto_tree:
proto_tree_add_uint_format(tree, id, tvb, start, length, value,
format, ...);
proto_item *
proto_tree_add_uint_format_value(tree, id, tvb, start, length,
value, format, ...);
proto_item *
proto_tree_add_uint64(tree, id, tvb, start, length, value);
@ -1729,6 +1773,10 @@ protocol or field labels to the proto_tree:
proto_tree_add_uint64_format(tree, id, tvb, start, length, value,
format, ...);
proto_item *
proto_tree_add_uint64_format_value(tree, id, tvb, start, length,
value, format, ...);
proto_item *
proto_tree_add_int(tree, id, tvb, start, length, value);
@ -1739,6 +1787,10 @@ protocol or field labels to the proto_tree:
proto_tree_add_int_format(tree, id, tvb, start, length, value,
format, ...);
proto_item *
proto_tree_add_int_format_value(tree, id, tvb, start, length,
value, format, ...);
proto_item *
proto_tree_add_int64(tree, id, tvb, start, length, value);
@ -1746,6 +1798,10 @@ protocol or field labels to the proto_tree:
proto_tree_add_int64_format(tree, id, tvb, start, length, value,
format, ...);
proto_item *
proto_tree_add_int64_format_value(tree, id, tvb, start, length,
value, format, ...);
proto_item*
proto_tree_add_text(tree, tvb, start, length, format, ...);
@ -2006,6 +2062,31 @@ the arguments are a "printf"-style format and any arguments for that
format. The caller must include the name of the field in the format; it
is not added automatically as in the proto_tree_add_XXX() functions.
proto_tree_add_bytes_format_value()
proto_tree_add_time_format_value()
proto_tree_add_ipxnet_format_value()
proto_tree_add_ipv4_format_value()
proto_tree_add_ipv6_format_value()
proto_tree_add_ether_format_value()
proto_tree_add_string_format_value()
proto_tree_add_boolean_format_value()
proto_tree_add_float_format_value()
proto_tree_add_double_format_value()
proto_tree_add_uint_format_value()
proto_tree_add_uint64_format_value()
proto_tree_add_int_format_value()
proto_tree_add_int64_format_value()
----------------------------
These routines are used to add items to the protocol tree when the
dissector routines wants complete control over how the value will be
represented on the GUI tree. The argument giving the value is the same
as the corresponding proto_tree_add_XXX() function; the rest of the
arguments are a "printf"-style format and any arguments for that format.
With these routines, unlike the proto_tree_add_XXX_format() routines,
the name of the field is added automatically as in the
proto_tree_add_XXX() functions; only the value is added with the format.
proto_tree_add_text()
---------------------
proto_tree_add_text() is used to add a label to the GUI tree. It will