#include <nitro/fs.h>
BOOL FS_LoadOverlayImageAsync(FSOverlayInfo *p_ovi, FSFile *p_file);
p_ovi | FSOverlayInfo structure that holds overlay module information. |
p_file | Pointer to the FSFile structure used for asynchronous reading. This structure's state must not indicate that a file is already open. Once this function succeeds and the read process ends, you must explicitly close the file using the FS_CloseFile function. |
Returns TRUE if the overlay module's load process started correctly; FALSE otherwise.
This function asynchronously loads the image of an overlay module to memory. If this function succeeds, the specified p_file
opens the file and enters the reading state. When the function waits for the read process to complete, it is equivalent to the FS_LoadOverlayImage function.
When loading an overlay whose area conflicts with an existing loaded overlay, you must unload the previous overlay using the FS_UnloadOverlay
function.
For information about the relationship with other overlay functions that perform equivalent processes, see the example stated in the reference for the FS_LoadOverlay
function.
FSOverlayInfo, FS_LoadOverlayInfo, FS_GetOverlayTotalSize, FS_GetOverlayAddress, FS_GetOverlayFileID, FS_LoadOverlayImage, FS_StartOverlay, FS_UnloadOverlayImage FS_LoadOverlay,
2004/11/17 Made corrections regarding FS_RegisterOverlayToDebugger
, which has been eliminated.
2004/11/16 Initial version.
CONFIDENTIAL