FS_UnloadOverlayImage

C Specification

#include <nitro/fs.h>

BOOL FS_UnloadOverlayImage(FSOverlayInfo *p_ovi);

Arguments

p_ovi FSOverlayInfo structure that holds overlay module information

Return Values

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

Description

This function unloads the image of an overlay module from memory. Currently, this function only calls the FS_EndOverlay function internally. When loading an overlay module, this function must be called for all other loaded modules that contend for space.

See Also

FSOverlayInfo, FS_LoadOverlayInfo, FS_LoadOverlayImage, FS_EndOverlay

Revision History

11/02/2004 Corrected a link.
09/10/2004 Added description concerning FS_EndOverlay.
06/11/2004 Initial version.