Firelight Technologies FMOD Studio API

File_GetDiskBusy

Information function to retreive the state of fmod's disk access.

C++ Syntax

FMOD_RESULT File_GetDiskBusy(
  int *busy
);

C Syntax

FMOD_RESULT FMOD_File_GetDiskBusy(
  int *busy
);

Parameters

busy

Address of an integer to receive the busy state of the disk at the current time.

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

Do not use this function to syncrhonize your own reads with, as due to timing, you might call this function and it says false = it is not busy, but the split second after call this function, internally FMOD might set it to busy. Use File_SetDiskBusy for proper mutual exclusion as it uses semaphores.

See Also

• File_SetDiskBusy

Version 1.03.06 Built on Apr 17, 2014