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
);

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.

See Also

• FMOD_STUDIO_PARAMETER_DESCRIPTION

Version 1.03.06 Built on Apr 17, 2014