Firelight Technologies FMOD Studio API
Studio::System::getBankByID
Retrieves an already loaded Bank object by ID.
C++ Syntax
FMOD_RESULT Studio::System::getBankByID(
const FMOD_GUID *id,
Studio::Bank **bank
);
C Syntax
FMOD_RESULT FMOD_Studio_System_GetBankByID(
FMOD_STUDIO_SYSTEM *system,
const FMOD_GUID *id,
FMOD_STUDIO_BANK **bank
);
C# Syntax
RESULT Studio.System.getBankByID(
Guid guid,
out Bank bank
);
JavaScript Syntax
System.getBankByID(
id,
bank // writes value to bank.val
);
Parameters
- id
- The 128-bit GUID which 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
The bank ID can be looked up using Studio::System::lookupID or parsed from a string using Studio::parseID.
See Also
Version 1.10.03 Built on Feb 1, 2018