Codex API: Plug-Ins

GetArchivesByPlugInEx

The GetArchivesByPlugInEx function obtains the list of supported archive formats by the chosen plug-in.

Parameters

lpPlugIn

[in] Pointer to a null-terminated string that specifies the name of the plug-in for which archive support information should be returned.

This name may be obtained using the GetPlugInsEx function.

lpArchives

[out] Pointer to a buffer that receives the list of all archive types supported by the plug-in 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.

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, COMMATEXT