Firelight Technologies FMOD Studio API

Studio::System::setUserData

Sets arbitrary user data on the system.

C++ Syntax

FMOD_RESULT Studio::System::setUserData(
  void *userData
);

C Syntax

FMOD_RESULT FMOD_Studio_System_SetUserData(
  FMOD_STUDIO_SYSTEM *system,
  void *userData
);

C# Syntax

RESULT Studio.System.setUserData(
  IntPtr userdata
);

JavaScript Syntax

System.setUserData(
  userdata                         
);

Parameters

userData

Address of user data to store within the system.

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

• Studio::System::getUserData

Version 1.10.03 Built on Feb 1, 2018