Firelight Technologies FMOD Studio API
Studio::System::getBank
Retrieves an already loaded Bank object by path, filename or ID string.
C++ Syntax
FMOD_RESULT Studio::System::getBank(
const char *path,
Studio::Bank **bank
);
C Syntax
FMOD_RESULT FMOD_Studio_System_GetBank(
FMOD_STUDIO_SYSTEM *system,
const char *path,
FMOD_STUDIO_BANK **bank
);
C# Syntax
RESULT Studio.System.getBank(
string path,
out Bank bank
);
JavaScript Syntax
System.getBank(
path,
bank // writes value to bank.val
);
Parameters
- path
- The bank path, filename, or the ID string that identifies the bank.
- bank
- Address of a variable to receive the Bank object.
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
If a bank path or ID is passed in, this is equivalent to calling Studio::System::lookupID or Studio::parseID and then calling Studio::System::GetBankByID. If a bank filename is passed in, it is first converted to a bank path.
The path field can be the bank path such as 'bank:/Weapons', the bank filename such as '../Desktop/Weapons.bank', or the ID such as '{793cddb6-7fa1-4e06-b805-4c74c0fd625b}'.
See Also
Version 1.10.03 Built on Feb 1, 2018