Studio:Auxiliary data

From STRIDE Wiki
Revision as of 19:01, 29 February 2008 by Timd (talk | contribs)
Jump to navigation Jump to search

If auxiliary data is enabled (srCFG_AUXDATA is set to 1 in srcfg.h), auxiliary data is transmitted with each message. The data you set using srSetAuxData for the particular STID is transferred with each message. Once the value is set, the same value will be transmitted with each message until you change the value.

With srGetAuxData, you can read the data. The value returned will be the one that was received with the most recent message on that STID. The auxiliary data is bidirectional, which means that there is a set of data which is sent in each direction. srSetAuxData sets the transmit auxiliary data and srGetAuxData reads the received auxiliary data. Transmit auxiliary data is accessible in a write-only manner through srSetAuxData, and receiving auxiliary data is accessible in a read-only manner through srGetAuxData.