CML Reference Guide

CML Reference Guide Appendix: Property Numbers


Several CML functions use "text property numbers" as a way to record the "type" of text in an item or response, or some other control information about that item or response.  These functions include $re_prop(), $re_bits(), $add_item(), $add_resp(), and $chg_resp().

While the meaning of specific property numbers or bits is not explicitly tied to the CML functions, there is a convention for the use of these numbers in the Caucus 4.x interface.  If you wish to reserve property values for your own customized application, please contact CaucusCare, so that we may reserve some bits for you, and avoid conflicts with them in future releases.

Property numbers (aka property bits) are stored as a single 16-bit number, as part of the data that makes up an item or response.  Functions $add_resp() and $add_item() store the complete 16-bit property number in the item or response.

The function $re_prop() returns the low-order 4 bits of this number (bits 0-3, right-endian), values 0 through 0x0F, for a particular item or response.  Currently, the following values are assigned specific meanings:

The function $re_bits() returns the high-order 12 bits of the item/response property number.  These bits have assigned meanings that are independent of each other.  Use the $bit_and() function to test individual bits.