Codex API: Archives


The InstallArchive function initiates the automated installation of an application contained inside an archive. The application must already have an installer in the archive.


VOID InstallArchive(
    LPCTSTR lpArchive  // archive to install



[in] Pointer to a null-terminated string that specifies the full path of the archive to install.

The archive must be supported for decompression. Use the GetExtractableArchivesEx function to obtain a list of archives supported for decompression. Furthermore, a "Structured" decompression profile must exist for the archive. Use the GetExtractionProfilesEx function to obtain a list of supported decompression profiles for the archive.

The archive must contain a setup program. InstallArchive looks for files named "setup.exe" or "install.exe" in the archive.

Return Values

This function does not return any values.


InstallArchive invokes the decompression plug-in mapped to the given archive type, and extracts entire archive contents to a temporary folder. The plug-in is responsible for displaying progress and feedback to the user during the extraction process. The plug-in must also handle error conditions.

Once the extraction is complete, InstallArchive starts the setup program. The function returns when the setup program finishes execution. The temporary folder must be manually deleted using the EraseWorkingFiles function.

Use the CheckOutArchive function for archives which do not contain built-in installers.


Windows NT/2000/XP: Requires Windows NT 4.0 SP4 or later.
Windows 95/98/Me:
Requires Windows 98 (or Windows 95 with DCOM 1.2).
Declared in mCodexAPI.h.
Use mCodexAPI.dll.

See Also

Codex API Overview, Codex API Functions, GetExtractableArchivesEx, GetExtractionProfilesEx, CheckOutArchive, EraseWorkingFiles