Codex API: Archives


The GetArchiveToolHints function obtains the list of hints for custom tools associated with an archive.

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


LPCTSTR GetArchiveToolHints(
    LPCTSTR lpArchive         // archive format



[in] Pointer to a null-terminated string that specifies the archive for which custom tool hint 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 tool hints formatted as COMMATEXT.

If no archive tool hints are available, the function returns NULL.

The tool hints returned are at corresponding positions with the actual tools returned by the GetArchiveTools function. For instance, the 3rd tool hint returned by the GetArchiveToolHints function is for the 3rd tool returned by the GetArchiveTools function.


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