Firelight Technologies FMOD Studio API

Studio::Bank::getEventList

Retrieves the EventDescriptions in the bank.

C++ Syntax

FMOD_RESULT Studio::Bank::getEventList(
  Studio::EventDescription **array,
  int capacity,
  int *count
);

C Syntax

FMOD_RESULT FMOD_Studio_Bank_GetEventList(
  FMOD_STUDIO_BANK *bank,
  FMOD_STUDIO_EVENTDESCRIPTION **array,
  int capacity,
  int *count
);

C# Syntax

RESULT Studio.Bank.getEventList(
  out EventDescription[] array
);

JavaScript Syntax

Bank.getEventList(
  array,                           // writes value to array.val
  capacity,                        
  count                            // writes value to count.val
);

Parameters

array

An array of memory allocated by the user.

capacity

The capacity of the array passed in as the first parameter

count

Address of a variable to receive the number of Event Descriptions written to the array

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::getEventCount 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::getEventCount

Version 1.10.03 Built on Feb 1, 2018