Firelight Technologies FMOD Studio API

Sound::getName

Retrieves the name of a sound.

C++ Syntax

FMOD_RESULT Sound::getName(
  char *name,
  int namelen
);

C Syntax

FMOD_RESULT FMOD_Sound_GetName(
  FMOD_SOUND *sound,
  char *name,
  int namelen
);

Parameters

name

Address of a variable that receives the name of the sound.

namelen

Length in bytes of the target buffer to receieve the string.

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

if FMOD_LOWMEM has been specified in System::createSound, this function will return "(null)".

See Also

• System::createSound
• FMOD_MODE

Version 1.03.06 Built on Apr 17, 2014