Firelight Technologies FMOD Studio API

Studio::CommandReplay::getCommandString

Retrieves a text string representation of the command at the given index.

C++ Syntax

FMOD_RESULT Studio::CommandReplay::getCommandString(
  int commandIndex,
  char *buffer,
  int length
);

C Syntax

FMOD_RESULT FMOD_Studio_CommandReplay_GetCommandString(
  FMOD_STUDIO_COMMANDREPLAY *commandreplay,
  int commandIndex,
  char *buffer,
  int length
);

C# Syntax

RESULT Studio.CommandReplay.getCommandString(
  int commandIndex,
  out string description
);

JavaScript Syntax

CommandReplay.getCommandString(
  commandindex,                    
  buffer                           // writes value to buffer.val
);

Parameters

commandIndex

The index of the command.

buffer

Address of the variable to receive the string.

length

The capacity of the buffer.

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

If the retrieved path is too long to fit in the supplied buffer, it will be truncated and this function will return FMOD_ERR_TRUNCATED.

JavaScript only :

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

See Also

• Studio::CommandReplay::getCommandCount
• Studio::CommandReplay::getCommandInfo
• Studio::CommandReplay::getCommandAtTime

Version 1.10.03 Built on Feb 1, 2018