Miles Sound System SDK 7.2a

AIL_sample_user_data

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

SINTa AIL_sample_user_data(
  HSAMPLE S,
  U32 index
);

In Parameters

S: indicates the sample 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

Sample user data entries are provided to assist application programs in keeping track of its allocated sample handles. They are especially useful for communicating with callback functions to which only sample 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 sample handle is freed.

Group: Digital Audio Services
Related Functions: AIL_set_sample_user_data
Related Basic Types: HSAMPLE, SINTa, U32