Firelight Technologies FMOD Studio API

Studio::System::getBankList

Retrieves the loaded Banks.

C++ Syntax

FMOD_RESULT Studio::System::getBankList(
  Studio::Bank **array,
  int capacity,
  int *count
);

C Syntax

FMOD_RESULT FMOD_Studio_System_GetBankList(
  FMOD_STUDIO_SYSTEM *system,
  FMOD_STUDIO_BANK **array,
  int capacity,
  int *count
);

Parameters

array

An array of memory allocated by the user.

capacity

The capacity of the array passed in as the first parameter

count

Address of a variable to receive the number of Banks written to the array

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

Used in conjunction with Studio::System::getBankCount to enumerate the banks.

See Also

• Studio::System::getBankCount
• Studio::Bank::getEventList
• Studio::Bank::getMixerStripList

Version 1.03.06 Built on Apr 17, 2014