FS_SuspendArchive

Syntax

#include <nitro/fs.h>

BOOL FS_SuspendArchive(FSArchive *p_arc);

Arguments

p_arc Address of the FSArchive structure.

Return Values

FALSE if archive is in the suspended state before the change. TRUE if not.

Description

Sets the archive to the halted state. While the archive is stopped, commands that are sent from the file system are stored in the process-wait state.
To return the archive from the halted state to the normal state, call FS_ResumeArchive. In order to control the archive state immediately after the archive is loaded, you must call this function before you call the FS_LoadArchive function.

See Also

Revision History

2004/07/12 Changed the return value type
2004/06/30 Initial Version


CONFIDENTIAL