|
GetArchiveSizeEx
The GetArchiveSizeEx
function opens an archive and prepares basic archive information. The
prepared archive information will be further queried using the GetArchiveInfoEx function. This
is a plug-in defined function.
|
|
INT GetArchiveSizeEx(
LPCTSTR lpFileName,
// name of file to open
BOOL bSilent,
//
silent operation flag
INT iItems,
// required buffer length for names of files inside archive
INT iPwdItems, //
required buffer length for names of password protected files inside archive
INT iDateTimes,
//
required buffer length for dates and times of files inside archive
INT iSizes,
//
required buffer length for sizes of files inside archive
INT iCompSizes
//
required buffer length for compressed sizes of files inside archive
); |
Parameters
lpFileName
[in] Pointer to a null-terminated
string that specifies the full path of the archive to query.
bSilent
[in] Boolean value indicating
whether to work in silent mode.
if bSilent is TRUE,
you should not prompt the user with any information (such as errors) or
requests (such as spanned media disk changes) that may be necessary. The
plug-in must decide how to act on all such conditions.
if bSilent is FALSE,
you may prompt the user for any and all needs.
iItems
[out] The required size
of the buffer to hold the names of files inside the archive, excluding
the null terminator.
iPwdItems
[out] The required size
of the buffer to hold the names of password protected files inside the
archive, excluding the null terminator.
iDateTimes
[out] The required size
of the buffer to hold the dates and times of files inside the archive,
excluding the null terminator.
iSizes
[out] The required size
of the buffer to hold the sizes of files inside the archive, excluding
the null terminator.
iCompSizes
[out] The required size
of the buffer to hold the compressed sizes of files inside the archive,
excluding the null terminator.
Return
Values
If the function succeeds,
the return value is the count of items inside the archive.
If the function fails, the return value is -1. The user may call the GetArchiveErrorEx
function to obtain error details, therefore GetArchiveSizeEx
may need to set internal error level flags if an error occurred.
Remarks
Applications will first
call the GetArchiveSizeEx function
to determine the length of the buffers they need to allocate to receive
archive information. If the GetArchiveSizeEx
function succeeds, applications will then call the GetArchiveInfoEx function to retrieve
the actual archive information.
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, GetArchiveInfoEx, GetArchiveErrorEx,
COMMATEXT
|