Firelight Technologies FMOD Studio API

FMOD_FILE_READ_CALLBACK

Callback for reading from a file.

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_FILE_READ_CALLBACK(
  void *handle,
  void *buffer,
  unsigned int sizebytes,
  unsigned int *bytesread,
  void *userdata
);

Parameters

handle

This is the handle you returned from the open callback to use for your own file routines.

buffer

The buffer to read your data into.

sizebytes

The number of bytes to read.

bytesread

The number of bytes successfully read.

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 the callback is from System::attachFileSystem, then the return value is ignored.

See Also

• System::setFileSystem
• System::attachFileSystem
• FMOD_FILE_OPEN_CALLBACK
• FMOD_FILE_CLOSE_CALLBACK
• FMOD_FILE_SEEK_CALLBACK

Version 1.10.03 Built on Feb 1, 2018