Firelight Technologies FMOD Studio API

FMOD_FILE_ASYNCCANCEL_CALLBACK

Callback to notify user that the resources associated with the file are about to be freed. Any asynchronous operations must be cancelled at this point before returning from the callback.

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_FILE_ASYNCCANCEL_CALLBACK(
  FMOD_ASYNCREADINFO *info,
  void *userdata
);

Parameters

info

Pointer to FMOD_ASYNCREADINFO structure. Use this structure to get a reference for your own system, note that the read that use this structure may have already completed.

userdata

Userdata from FMOD_CREATESOUNDEXINFO.fileuserdata or FMOD_STUDIO_BANK_INFO.userData.

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 asynchronous operations on this file are not cancelled before returning fom this callback, then FMOD will free the memory associated with the file and the user routine may read to an invalid/freed pointer - causing a crash.

See Also

• System::setFileSystem
• FMOD_FILE_OPEN_CALLBACK
• FMOD_FILE_CLOSE_CALLBACK
• FMOD_FILE_READ_CALLBACK
• FMOD_FILE_SEEK_CALLBACK
• FMOD_FILE_ASYNCREAD_CALLBACK
• FMOD_ASYNCREADINFO

Version 1.10.03 Built on Feb 1, 2018