Firelight Technologies FMOD Studio API
Studio::System::lookupPath
Retrieves the path for a bank, event, snapshot, bus or VCA.
C++ Syntax
FMOD_RESULT Studio::System::lookupPath(
const FMOD_GUID *id,
char *path,
int size,
int *retrieved
);
C Syntax
FMOD_RESULT FMOD_Studio_System_LookupPath(
FMOD_STUDIO_SYSTEM *system,
const FMOD_GUID *id,
char *path,
int size,
int *retrieved
);
C# Syntax
RESULT Studio.System.lookupPath(
Guid guid,
out string path
);
JavaScript Syntax
System.lookupPath(
id,
path, // writes value to path.val
size,
retrieved // writes value to retrieved.val
);
Parameters
- id
- The 128-bit GUID which identifies the bank, event, snapshot, bus or VCA.
- 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
This function will return FMOD_ERR_EVENT_NOTFOUND unless string data for the requested object is loaded (by loading the "Master Bank.strings.bank" file).
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