FS_COMMAND_CLOSEFILE

Definition


FSResult FS_ARCHIVE_PROC_FUNC(FSFile *p_file, FSCommandType command /* = FS_COMMAND_CLOSEFILE */);

Description

Operating specifications for the archive command FS_COMMAND_CLOSEFILE are shown below:

Arguments passed to this command 
This command takes as a command argument the variable arg.closefile that is stored in p_file.
 
This variable is defined in nitro/fs/file.h as shown below:

typedef struct
{
    u32    reserved;
} FSCloseFileInfo;
Argument content is listed below:
Arguments Content
reserved Not used

Actions required of this command 
p_file is a handle that always holds file information in prop.file.

Based on this information, in order to close a file it carries out required, special processes.
Default Implementation
None
Command Results
If FS_RESULT_SUCCESS is returned by the command, p_file will no longer be a handle that holds file information.
From that point the FS_IsFile function will return FALSE.
This is the same state that exists immediately after the FS_InitFile function is called.
Functions that use this command
FS_CloseFile

See Also

FSArchive, FS_ARCHIVE_PROC_FUNC, FS_COMMAND_*, FS_SetArchiveProc

Revision History

2004/07/12 Initial version.

CONFIDENTIAL