Firelight Technologies FMOD Studio API

System::getPluginInfo

Retrieves information to display for the selected plugin.

C++ Syntax

FMOD_RESULT System::getPluginInfo(
  unsigned int handle,
  FMOD_PLUGINTYPE *plugintype,
  char *name,
  int namelen,
  unsigned int *version
);

C Syntax

FMOD_RESULT FMOD_System_GetPluginInfo(
  FMOD_SYSTEM *system,
  unsigned int handle,
  FMOD_PLUGINTYPE *plugintype,
  char *name,
  int namelen,
  unsigned int *version
);

Parameters

handle

Handle to a pre-existing plugin.

plugintype

Address of a variable that receives the type of the plugin, FMOD_PLUGINTYPE_OUTPUT, FMOD_PLUGINTYPE_CODEC or FMOD_PLUGINTYPE_DSP.

name

Address of a variable that receives the name of the plugin.

namelen

Length in bytes of the target buffer to receieve the string.

version

Address of a variable that receives the version number set by the plugin.

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_PLUGINTYPE
• System::getNumPlugins

Version 1.03.06 Built on Apr 17, 2014