|
GetArchiveFunctionsByPlugIn
The GetArchiveFunctionsByPlugIn
function obtains the list of supported archive functions for the chosen
archive format provided by the chosen plug-in.
Note
This function is provided for backwards compatibility only. Newer applications
should use the GetArchiveFunctionsByPlugInEx
function.
|
|
LPCTSTR
GetArchiveFunctionsByPlugIn(
LPCTSTR lpArchive,
// archive format
LPCTSTR lpPlugIn
// name of plug-in
); |
Parameters
lpArchive
[in] Pointer to a null-terminated
string that specifies the archive format for which information is requested.
This archive format must be supported by the plug-in specified in the
lpPlugIn parameter.
Information on which archives are supported by which plug-ins may be obtained
using the GetArchivesByPlugIn
function.
lpPlugIn
[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 functions supported by the indicated plug-in for the
given archive type. The list is formatted as COMMATEXT.
Below is the list of standard Codex defined archive
functions:
|
Function |
Meaning |
|
List Archive Contents |
The plug-in supports enumeration
of files contained inside archives of this type. |
|
Compress |
The plug-in supports compressing
files into archives of this type. Whether existing archives may be updated
with new files is not specified. |
|
Compression Settings |
The plug-in supports user
configuration of compression settings for this archive type. |
|
Extract |
The plug-in supports extracting
files from archives of this type. |
|
Extraction Settings |
The plug-in supports user
configuration of extraction settings for this archive type. |
In addition to the standard
functions above, each plug-in may define custom functions that are specific
to the archive types they work with. For instance, ZIP archives support
comments, therefore a custom plug-in function for ZIP archives may be
"Edit Comment".
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
Codex
API Overview, Codex API Functions, GetPlugIns, GetArchivesByPlugIn
|