Firelight Technologies FMOD Studio API

Sound::getUserData

Retrieves the user value that that was set by calling the Sound::setUserData function.

C++ Syntax

FMOD_RESULT Sound::getUserData(
  void **userdata
);

C Syntax

FMOD_RESULT FMOD_Sound_GetUserData(
  FMOD_SOUND *sound,
  void **userdata
);

C# Syntax

RESULT Sound.getUserData(
  out IntPtr userdata
);

JavaScript Syntax

Sound.getUserData(
  userdata                         // writes value to userdata.val
);

Parameters

userdata

Address of a pointer that receives the data specified with the Sound::setUserData function.

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.

See Also

• Sound::setUserData

Version 1.10.03 Built on Feb 1, 2018