Firelight Technologies FMOD Studio API

Studio::EventDescription::getUserProperty

Retrieves a user property by name.

C++ Syntax

FMOD_RESULT Studio::EventDescription::getUserProperty(
  const char *name,
  FMOD_STUDIO_USER_PROPERTY *property
);

C Syntax

FMOD_RESULT FMOD_Studio_EventDescription_GetUserProperty(
  FMOD_STUDIO_EVENTDESCRIPTION *eventdescription,
  const char *name,
  FMOD_STUDIO_USER_PROPERTY *property
);

C# Syntax

RESULT Studio.EventDescription.getUserProperty(
  string name,
  out USER_PROPERTY property
);

JavaScript Syntax

EventDescription.getUserProperty(
  name,                            
  property                         // writes value to property.val
);

Parameters

name

Name of the user property

property

Address of a variable to receive the user property.

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

• FMOD_STUDIO_USER_PROPERTY
• Studio::EventDescription::getUserPropertyCount
• Studio::EventDescription::getUserPropertyByIndex

Version 1.10.03 Built on Feb 1, 2018