Codex API: Plug-Ins

GetArchivesEx

The GetArchivesEx function obtains the list of supported archives by all installed plug-ins on the system.

 

INT GetArchivesEx(
    LPTSTR lpArchives  // supported archives
);

Parameters

lpArchives

[out] Pointer to a buffer that receives the list of all archives supported by plug-ins installed on the system formatted as COMMATEXT.

The archive types are represented as file masks. For example, CAB archives will be represented as "*.CAB" (without the quotes). SZDD archives (archives created using Microsoft's COMPRESS.EXE program) will be represented as "*.??_". This assures that archives will always be correctly identified, even if the archive extension is variable, as in the SZDD archive type.

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.

Remarks

This function does not return the actual list of archives which you may work with. The user may disable or reassign the mappings from plug-ins to the archive types they support. Certain archive types may therefore be partially or entirely disabled.

See the GetSupportedArchivesEx and EditPlugInBindings functions for more information.

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, GetPlugInsEx, GetSupportedArchivesEx, EditPlugInBindings, COMMATEXT