Codex SDK: Plug-In DLL Functions

GetArchiveErrorEx

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

 

INT GetArchiveErrorEx(
    LPTSTR lpError      // points to error description
);

Parameters

lpError

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

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 may only be called after the GetArchiveInfo or GetArchiveSizeEx function returns -1, indicating a failure.

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

SDK Overview, Plug-In Features, GetArchiveSizeEx