Codex SDK: Plug-In DLL Functions


The GetArchiveError function describes the error that occurred during the last archive open operation. This is a plug-in defined function.

This function has been superceded by the GetArchiveErrorEx function starting with Codex 2.1, however plug-ins may choose to continue implementing this function to retain compatibility with Codex 2.0 applications.


VOID GetArchiveError(
    LPTSTR lpError    // points to error description



[out] Pointer to the buffer that receives the textual description of the last archive open error that occurred.

Return Values

This function does not return any values.


This function may only be called after the GetArchiveInfo function returns -1, indicating a failure.


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

SDK Overview, Plug-In Features, GetArchiveInfo