doc: bt_field_class...get_mapping_labels...(): clarify RV's validity
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Thu, 12 Mar 2020 17:33:09 +0000 (13:33 -0400)
committerPhilippe Proulx <eeppeliteloop@gmail.com>
Thu, 12 Mar 2020 17:43:13 +0000 (13:43 -0400)
commit45397ca4f49f5d93e0c2c178d68d37224a8a9d47
treed0c733e75b5127d4e3d0c5d90349ed409815d992
parent51fd98328dd32746627393a08eee9487c10e281e
doc: bt_field_class...get_mapping_labels...(): clarify RV's validity

The label array which
bt_field_class_enumeration_unsigned_get_mapping_labels_for_value() and
bt_field_class_enumeration_signed_get_mapping_labels_for_value() return
remains valid as long as:

* The enumeration field class is not modified.

* You don't call the same function again with the same enumeration
  field class.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I7b197ab5e176c77f4418d23b12e194c6477e5cf8
Reviewed-on: https://review.lttng.org/c/babeltrace/+/3224
include/babeltrace2/trace-ir/field-class.h
This page took 0.023377 seconds and 4 git commands to generate.