Firelight Technologies FMOD Studio API

ChannelGroup::getName

Retrieves the name of the channel group set when the group was created.

C++ Syntax

FMOD_RESULT ChannelGroup::getName(
  char *name,
  int namelen
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_GetName(
  FMOD_CHANNELGROUP *channelgroup,
  char *name,
  int namelen
);

C# Syntax

RESULT ChannelGroup.getName(
  StringBuilder name,
  int namelen
);

JavaScript Syntax

ChannelGroup.getName(
  name                             // writes value to name.val
);

Parameters

name

Address of a variable that receives the name of the channel group.

namelen

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

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

JavaScript only :

Note: For the "name" parameter, the maximum string length is 512.

See Also

• System::getMasterChannelGroup
• System::createChannelGroup

Version 1.10.03 Built on Feb 1, 2018