Studio::Bank::unload

FMOD Studio API

Firelight Technologies FMOD Studio API

Studio::Bank::unload

Unloads the bank and all of its data.

C++ Syntax

FMOD_RESULT Studio::Bank::unload();

C Syntax

FMOD_RESULT FMOD_Studio_Bank_Unload(FMOD_STUDIO_BANK *bank);

C# Syntax

RESULT Studio.Bank.unload();

JavaScript Syntax

Bank.unload();

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

This will destroy all objects created from the bank, unload all sample data inside the bank, and invalidate all API handles referring to the bank.

See Also




Version 1.10.03 Built on Feb 1, 2018