Firelight Technologies FMOD Studio API

Studio::ParameterInstance::getDescription

Retrieves the description for the parameter.

C++ Syntax

FMOD_RESULT Studio::ParameterInstance::getDescription(
  FMOD_STUDIO_PARAMETER_DESCRIPTION *description
);

C Syntax

FMOD_RESULT FMOD_Studio_ParameterInstance_GetDescription(
  FMOD_STUDIO_PARAMETERINSTANCE *parameterinstance,
  FMOD_STUDIO_PARAMETER_DESCRIPTION *description
);

C# Syntax

RESULT Studio.ParameterInstance.getDescription(
  out PARAMETER_DESCRIPTION description
);

JavaScript Syntax

ParameterInstance.getDescription(
  description                      // writes value to description.val
);

Parameters

description

Address of a variable to receive the parameter description.

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

NOTE: This class is deprecated. It will be removed in a future version. Please get and set parameter values using Studio::EventInstance::getParameterValue, Studio::EventInstance::setParameterValue, Studio::EventInstance::getParameterValueByIndex, and Studio::EventInstance::setParameterValueByIndex.

See Also

• FMOD_STUDIO_PARAMETER_DESCRIPTION
• Studio::EventInstance::getParameterValue
• Studio::EventInstance::setParameterValue
• Studio::EventInstance::getParameterValueByIndex
• Studio::EventInstance::setParameterValueByIndex

Version 1.10.03 Built on Feb 1, 2018