Firelight Technologies FMOD Studio API

Studio::Bank::getEventCount

Retrieves the number of EventDescriptions in the bank.

C++ Syntax

FMOD_RESULT Studio::Bank::getEventCount(
  int *count
);

C Syntax

FMOD_RESULT FMOD_Studio_Bank_GetEventCount(
  FMOD_STUDIO_BANK *bank,
  int *count
);

C# Syntax

RESULT Studio.Bank.getEventCount(
  out int count
);

JavaScript Syntax

Bank.getEventCount(
  count                            // writes value to count.val
);

Parameters

count

Address of a variable to receive the number of EventDescriptions.

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

Can be used in conjunction with Studio::Bank::getEventList to enumerate the events.

NOTE! This function only counts events that have been added explicitly to the bank by the sound designer. Events that have been implicitly included via event instrument references are not counted.

See Also

• Studio::Bank::getEventList

Version 1.10.03 Built on Feb 1, 2018