FS_LoadOverlayImage

Syntax

#include <nitro/fs.h>

BOOL FS_LoadOverlayImage(FSOverlayInfo *p_ovi);

Arguments

p_ovi FSOverlayInfo structure that holds overlay module information.

Return Values

Returns TRUE if the overlay module's image is loaded properly; FALSE otherwise.

Description

This function loads the image of an overlay module to memory. It will construct the "raw initial state" of the overlay module in memory. The subsequent running of the static initializer using the FS_StartOverlay function enables the overlay module.
When loading an overlay whose area conflicts with an existing loaded overlay, you must unload the previous overlay using the FS_UnloadOverlay function.
This process is equivalent to calling the FS_LoadOverlayImageAsync function and waiting for the load process to finish. For information about the relationship with other overlay functions that perform equivalent processes, see the examples in the reference for the FS_LoadOverlay function.

Revision History

2004/11/16 Added comparison to FS_LoadOverlayImageAsync, revised description of the process.
2004/10/19 Added description regarding the process contents.
2004/09/24 Added description concerning the relationship with each type of overlay function.
2004/06/11 Initial version.