Miles Sound System SDK 7.2a

AIL_set_sequence_user_data

The function AIL_set_sequence_user_data sets a value for one of eight user data entries associated with each sequence handle.

void AIL_set_sequence_user_data(
  HSEQUENCE S,
  U32 index,
  SINTa value
);

In Parameters

S: indicates the sequence for which a user data entry value is to be set.
index: is a number from 0 to 7, indicating which user data entry is to be set.
value: is the 32-bit user data value to set.

Discussion

Sequence user data entries are provided to assist application programs in keeping track of its allocated sequence handles. They are especially useful for communicating with callback functions to which only sequence handles are passed, without resorting to the use of global variables.

The MSS system never alters or initializes user data values under any circumstances even when a sequence handle is freed.

Group: XMIDI Services
Related Functions: AIL_sequence_user_data
Related Basic Types: HSEQUENCE, SINTa, U32, void