Codex API: Plug-Ins


The LoadPlugIns function initializes the Codex runtime for use with an application. It loads all plug-ins installed on the system and creates internal structures necessary for mapping archives to plug-ins.

This function must be called before calling any other Codex API functions working directly with archives.


INT LoadPlugIns(VOID);


This function has no parameters.

Return Values

The function returns the total number of archive types supported by currently installed plug-ins.

If there are no archive types currently supported, the function returns 0. This does not mean that there are no plug-ins installed on the system. See remarks for details.


The mapping of plug-ins to archive types is a process which can be overseen and customized by the user. The user may associate different portions of different plug-ins with different archive types. Likewise, the user may dissociate all plug-ins from all archive types. Therefore, contrary to what the name indicates, this function does not load plug-ins but plug-ins as associated and ready for use with archive types.

When this function returns 0, do not automatically assume there are no plug-ins installed on the system.

When your Codex session is over, call the FreePlugIns function to free resource allocated by the Codex runtime.


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, QueryArchiveEx, FreePlugIns