DARCHCreate

Syntax

#include <revolution/darch.h>
BOOL DARCHCreate(void* arcStart, u32 arcSize, const DARCHFileInfo* fileInfo, const u32 fileInfoNum);

Arguments

arcStart Starting address of the archive file image.
arcSize Size of the archive file image.
fileInfo Pointer to structure containing file information of a file to archive.
fileInfoNum Number of files to archive.

Return Values

Returns TRUE if successful, FALSE if unsuccessful.

Description

The DARCHCreate function archives the file specified by the DARCHFileInfo structure and generates an archive file image.
To generate the image, the size and starting address of the buffer in which the archive file image is placed must be specified.

The size of the archive file image can be obtained using the DARCHGetArcSize function.

Note

If the number of characters of the absolute path of the file to be archived is larger than the file size, a DARCHCreate():allocation failed. error is returned because sufficient buffer memory could not be allocated.
After the archive file image is created, the buffer memory area will be overwritten by the archive file image.

See Also

DARCHGetArcSize, DARCHFileInfo

Revision History

2007/10/10 Initial version.


CONFIDENTIAL