FS_CancelFile

Syntax

#include <nitro/fs.h>

void FS_CancelFile( FSFile *p_file );

Arguments

p_file Address of the FSFile structure.

Return Values

None.

Description

Requests cancellation of the specified file (if it's currently running the asynchronous process). The function returns control without allowing the process to complete. To wait for the cancellation to be accepted or the actual process to be completed, use the FS_WaitAsync function. When the specified file is held in the archive as an unprocessed command, the cancellation is accepted as soon as the current command completes. When the specified file in the archive is an executable command, it depends whether or not the archive is implemented.

Revision History

2004/07/13 Initial version.