Codex API: Archives


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


INT GetArchiveToolHintsEx(
    LPCTSTR lpArchive,      // archive format

    LPTSTR lpHints          // archive tool hints




[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.


[out] Pointer to a buffer that receives the list of all available archive tool hints formatted as COMMATEXT. If no archive tools are available, the function returns NULL.

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

Pass NULL in this parameter to request the required size for the buffer.

Return Values

The return value specifies the required size of the buffer, excluding the number of bytes necessary for a terminating null character.


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