Codex API: Archives

GetArchiveToolsEx

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

 

INT GetArchiveToolsEx(
    LPCTSTR lpArchive,  // archive format

    LPTSTR lpTools      // archive tools

);

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.

lpTools

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

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.

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