Firelight Technologies FMOD Studio API

Studio::System::getBank

Retrieves an already loaded Bank object.

C++ Syntax

FMOD_RESULT Studio::System::getBank(
  const FMOD_GUID *id,
  Studio::Bank **bank
);

C Syntax

FMOD_RESULT FMOD_Studio_System_GetBank(
  FMOD_STUDIO_SYSTEM *system,
  const FMOD_GUID *id,
  FMOD_STUDIO_BANK **bank
);

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.03.06 Built on Apr 17, 2014