FS_EndOverlay

Syntax

#include <nitro/fs.h>

void FS_EndOverlay(FSOverlayInfo *p_ovi);

Arguments

p_ovi FSOverlayInfo structure that holds overlay module information.

Return Values

None.

Description

This function runs the overlay module's static uninitializer. A static uninitializer disassembles an object that has a static memory duration. This function must be called once before freeing an overlay module that was started by the FS_StartOverlay() function.

Internal Operation

In the case of an overlay that is coded in C++, this function runs a destructor for every object that is contained within the scope of the overlay.

See Also

FSOverlayInfo FS_LoadOverlayInfo FS_StartOverlay FS_UnloadOverlayImage

Revision History

2004/09/10 Initial version.

CONFIDENTIAL