Codex API: Plug-Ins


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

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


LPCTSTR GetArchivesByPlugIn(
    LPCTSTR lpPlugIn         // name of plug-in



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

Return Values

The function returns a 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.


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