Firelight Technologies FMOD Studio API

Studio::EventInstance::getUserData

Retrieves the user data that is set on the event instance.

C++ Syntax

FMOD_RESULT Studio::EventInstance::getUserData(
  void **userData
);

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_GetUserData(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  void **userData
);

C# Syntax

RESULT Studio.EventInstance.getUserData(
  out IntPtr userdata
);

JavaScript Syntax

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

Parameters

userData

Address of a variable to receive the user data.

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

• Studio::EventInstance::setUserData

Version 1.10.03 Built on Feb 1, 2018