Codex API: Archives

GetArchiveTools

The GetArchiveTools function obtains the list of custom tools associated with an archive.

Note This function is provided for backwards compatibility only. Newer applications should use the GetArchiveToolsEx function.

 

LPCTSTR GetArchiveTools(
    LPCTSTR lpArchive     // archive format
);

Parameters

lpArchive

[in] Pointer to a null-terminated string that specifies the archive for which custom tool information should be returned.

The lpArchive parameter must include the archive extension only. The extension may include wildcards.

Return Values

The function returns a list of all available archive tools formatted as COMMATEXT.

If no archive tools are available, the function returns NULL.

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, GetArchiveToolHints, RunArchiveTool