Firelight Technologies FMOD Studio API

Studio::EventDescription::getUserPropertyByIndex

Retrieves a user property by index.

C++ Syntax

FMOD_RESULT Studio::EventDescription::getUserPropertyByIndex(
  int index,
  FMOD_STUDIO_USER_PROPERTY *property
);

C Syntax

FMOD_RESULT FMOD_Studio_EventDescription_GetUserPropertyByIndex(
  FMOD_STUDIO_EVENTDESCRIPTION *eventdescription,
  int index,
  FMOD_STUDIO_USER_PROPERTY *property
);

C# Syntax

RESULT Studio.EventDescription.getUserPropertyByIndex(
  int index,
  out USER_PROPERTY property
);

JavaScript Syntax

EventDescription.getUserPropertyByIndex(
  index,                           
  property                         // writes value to property.val
);

Parameters

index

Index 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::getUserProperty

Version 1.10.03 Built on Feb 1, 2018