SB AWE32 Developer's Information Pack
PART III Windows Driver API
••
54
Copyright
Creative Technology Ltd., 1994-1996
Version 3.00
AWE_GET_USER_BANK
Actions
An application sends this message to the AWE Manager to request for the
descriptor describing the User Bank.
Parameters
lParam1
Specify a word data type. This word contains the UBank Index, pointing to
one of the 127 User Banks. Valid range is 1 to 127.
lParam2
Specify a far pointer to CBufferObject, LPBUFFEROBJECT. When the
application calls the manager, the following fields are used:
Member
Remarks
m_Size
Indicates the size of buffer available.
m_Buffer
Far pointer to a buffer area.
Upon returning, the manager will update the following fields:
Member
Remarks
m_SizeUsed
Number of characters from buffer used.
m_Buffer
String of current bank descriptor.
The buffer area will be filled by the manager with the descriptor of the
selected User Bank. The string ends with two consecutive '\0's. Size
returned includes the '\0's.
h
UserID
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 a trip
General Protection Fault in Windows.
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_UBANK_INVALID
AWE_ERR_RESOURCE_INSUFFICIENT
See Also
AWE_LOAD_USER_BANK, AWE_CLEAR_USER_BANK
AWE_CLEAR_USER_BANK
Actions
An application sends this message to remove a loaded User Bank from
memory.
Parameters
lParam1