FS_UnloadOverlay


C Specification

#include <nitro/fs.h>

BOOL FS_UnloadOverlay(MIProcessor target, FSOverlayID id);

Description

This function unloads an overlay module that is specified by a processor and is specified by a number.

This function is equivalent to acquiring overlay module information with the FS_LoadOverlayInfo function and calling the FS_UnloadOverlayImage function.

Arguments

target Unload target (main processor/sub processor).
id The module to unload.

Return Values

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

See Also

FSOverlayInfo, FSOverlayID, FS_OVERLAY_ID, FS_LoadOverlayInfo, FS_UnloadOverlayImage, FS_LoadOverlay

Revision History

06/11/2004 Added descriptions due to additional overlay functions
04/08/2004 Revised description due to changing the FSOverlayID type
04/05/2004 Revised description due to addition of the FSOverlayID type
04/01/2004 Initial version