Miles Sound System SDK 7.2a

AIL_sequence_user_data

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

SINTa AIL_sequence_user_data(
  HSEQUENCE S,
  U32 index
);

In Parameters

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

Returns

The value which was previously stored at user data entry index.

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_set_sequence_user_data
Related Basic Types: HSEQUENCE, SINTa, U32