# FS_LoadOverlayImage

## C Specification

      #include <nitro/fs.h>

      BOOL FS_LoadOverlayImage(FSOverlayInfo *p_ovi);

## 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 example stated in the reference for the `FS_LoadOverlay` function.

## Arguments

`p_ovi` | `FSOverlayInfo` structure that holds overlay module information

## Return Values

Returns a value of TRUE if the overlay module's image is loaded properly. Otherwise, a value of FALSE is returned.

## See Also

`FSOverlayInfo, `FS_LoadOverlay`, FS_LoadOverlayInfo, `FS_LoadOverlayImageAsync`, FS_GetOverlayTotalSize, FS_GetOverlayAddress, FS_GetOverlayFileID, FS_StartOverlay, FS_UnloadOverlayImage`

## Revision History

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