Firelight Technologies FMOD Studio API

DSPConnection::getUserData

Sets a user value that the DSPConnection object will store internally. Can be retrieved with DSPConnection::getUserData.

C++ Syntax

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

C Syntax

FMOD_RESULT FMOD_DSPConnection_GetUserData(
  FMOD_DSPCONNECTION *dspconnection,
  void **userdata
);

Parameters

userdata

Address of user data that the user wishes stored within the DSPConnection object.

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 is primarily used in case the user wishes to 'attach' data to an FMOD object.

See Also

• DSPConnection::getUserData

Version 1.03.06 Built on Apr 17, 2014