Firelight Technologies FMOD Studio API

DSP::getUserData

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

C++ Syntax

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

C Syntax

FMOD_RESULT FMOD_DSP_GetUserData(
  FMOD_DSP *dsp,
  void **userdata
);

C# Syntax

RESULT DSP.getUserData(
  out IntPtr userdata
);

JavaScript Syntax

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

Parameters

userdata

Address of a pointer that receives the user data specified with the DSP::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

• DSP::setUserData

Version 1.10.03 Built on Feb 1, 2018