Firelight Technologies FMOD Studio API
Studio::Bank::getStringInfo
Retrieves the string table entry for the given index.
C++ Syntax
FMOD_RESULT Studio::Bank::getStringInfo(
int index,
FMOD_GUID *id,
char *path,
int size,
int *retrieved
);
C Syntax
FMOD_RESULT FMOD_Studio_Bank_GetStringInfo(
FMOD_STUDIO_BANK *bank,
int index,
FMOD_GUID *id,
char *path,
int size,
int *retrieved
);
C# Syntax
RESULT Studio.Bank.getStringInfo(
int index,
out Guid id,
out string path
);
JavaScript Syntax
Bank.getStringInfo(
index,
id, // writes value to id.val
path, // writes value to path.val
size,
retrieved // writes value to retrieved.val
);
Parameters
- index
- Index of string table entry to retrieve.
- id
- Address of a variable to receive the ID. Specify 0 or NULL to ignore.
- path
- Address of a buffer to receive the path. Specify 0 or NULL to ignore.
- size
- Size of the path buffer in bytes. Required if path parameter is not NULL.
- retrieved
- Address of a variable to receive the size of the retrieved path in bytes, including the terminating null character. Optional. Specify 0 or NULL to ignore.
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
The string table contains mappings from ID to path and is automatically used by Studio::System::lookupID and Studio::System::lookupPath. This function can be called to get the string data directly.
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. Use the retrieved parameter to obtain the minimum buffer size required to hold the full path.
JavaScript only :
Note: For the "path" parameter, the maximum string length is 512.
See Also
Version 1.10.03 Built on Feb 1, 2018