Codex API: Archives

RunArchiveTool

The RunArchiveTool function starts an archive specific tool.

Parameters

lpArchive

[in] Pointer to a null-terminated string that specifies the full path of the archive the tool should be run on.

lpItems

[in] Pointer to a null-terminated string formatted as COMMATEXT specifying the files inside the archive against which the tool should be run.

You may pass NULL in this parameter if the tool does not require this information. Tools which effect the entire archive (such as self-extracting archive creation tools) are examples of such tools.

lpTool

[in] Specifies the archive specific tool to be run.

Use the GetArchiveToolsEx function to obtain a list of archive specific tools.

Return Values

This function does not return any values.

Remarks

RunArchiveTool invokes the plug-in associated with the archive specific tool. The plug-in is responsible for displaying progress and feedback to the user. The plug-in must also handle error conditions. The plug-in may display any additional dialog boxes and custom interfaces required for the execution of the tool.

RunArchiveTool returns once the invoked plug-in finishes execution.

Requirements

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).
Header: Declared in mCodexAPI.h.
Library: Use mCodexAPI.dll.

See Also

Codex API Overview, Codex API Functions, GetArchiveToolsEx, GetArchiveToolHintsEx