Firelight Technologies FMOD Studio API

Channel::getUserData

Retrieves a user value that can be set with ChannelControl::setUserData.

C++ Syntax

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

C Syntax

FMOD_RESULT FMOD_Channel_GetUserData(
  FMOD_CHANNEL *channel,
  void **userdata
);

C# Syntax

RESULT Channel.getUserData(
  out IntPtr userdata
);

JavaScript Syntax

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

Parameters

userdata

Address of a variable to receives data that the user has stored within this 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.

See Also

• ChannelControl::setUserData

Version 1.10.03 Built on Feb 1, 2018