Creative AWE32 - Page 47

To Next Page

To Previous Page

SB AWE32 Developer's Information Pack PART III Windows Driver API •• 46

Member Remarks

m_SizeUsed Number of characters from buffer used.

m_Flag Number of entries written into the buffer.

m_Buffer String entries of type variations.

The

m_SizeUsed

includes the '\0's used to delimit entries. The buffer area

will be filled by the manager with the entries of Type Variation supported by

the current MIDI driver. These entries are in string format, each terminated

with a '\0'. The last entry of the list will have two consecutive '\0's. As an

example, we have:

"Chorus 1\0Chorus 2\0Chorus 3\0Chorus 4\0Feedback

Delay\0Flanger\0Short Delay\0Short Delay FB\0\0"

The

m_Flag

will have 8 and

m_SizeUsed

will be filled with 87.

hUserID

Current ID assigned to the application by the AWE Manager during

initialization.

Remarks

The following are some important points to note when using this function.

The location passed in as pointer must be valid memory locations allocated

by the parent application. If the locations are invalid, it is possible to trip a

General Protection Fault in Windows.

If the buffer is not sufficient to complete the operation, AWE Manager will

not update string entries into the buffer. However, other return parameters

will still be updated.

Return

The return value would be AWE_NO_ERR if the operation is successful, and

an error code otherwise. Possible errors are:

AWE_ERR_USERID_INVALID

AWE_ERR_EFXT_INVALID

AWE_ERR_RESOURCE_INSUFFICIENT

AWE_ERR_SYSMEM_INSUFFICIENT