Studio::System::lookupID

Retrieves the ID for a bank, event or mixer strip.

C++ Syntax

FMOD_RESULT Studio::System::lookupID(
  const char *path,
  FMOD_GUID *id
);

C Syntax

FMOD_RESULT FMOD_Studio_System_LookupID(
  FMOD_STUDIO_SYSTEM *system,
  const char *path,
  FMOD_GUID *id
);

Parameters

path: The path to the object as shown in FMOD Studio.
id: Address of a variable to receive the 128-bit GUID.

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 function will return FMOD_ERR_EVENT_NOTFOUND unless string data for the requested object is loaded (by loading the "Master Bank.strings.bank" file).

The path can be retrieved from FMOD Studio using the "Copy Path" context menu command. Paths must be in the following format: