JVCL Help:TJvCABFile
JVCL Help: TJvCABFile Class
Search in JVCL Help
Search in all projectsClass Hierarchy
TJvCABFile
run\JvCabFile.pas
Summary
Encapsulates access to .CAB (cabinet) files using the Setup API.
Pascal
run\JvCabFile.pas
TJvCABFile = class(TJvComponent);
Description
- JVCLInfo
TJvCABFile is a TJvComponent descendant that encapsulates access to .CAB (Cabinet) file using the Setup and Device Installer API. TJvCABFile has a dependency on the Setup and Device Installer API interface unit (SetupApi.pas) and the setupapi.dll file in Microsoft Windows.
Cabinet files provide a file format that offers an efficient way to package and compress multiple files into a single file. TJvCABFile properties, methods, and events can be used when listing files stored in the .CAB, or when extracting files for subsequent use or installation. TJvCABFile does NOT provide methods for creating or populating .CAB files. Use the CABARC.EXE utility to create or populate cabinet files.
An application can assign procedures for the event handlers that correspond to notifications from the Setup API, including:
| Event Handler Notification | --------------------- |
| --------------------------- ================== | |
| OnCABInfo SPFILENOTIFY_CABINETINFO | |
| OnFilesListed SPFILENOTIFY_FILEINCABINET | (general callback) |
| OnFileExtracted SPFILENOTIFY_FILEEXTRACTED | |
| OnStartFileExtraction SPFILENOTIFY_FILEINCABINET | (extract callback) |
| OnNeedNewCabinet SPFILENOTIFY_NEEDNEWCABINET |
After assigning any relevant event handler procedures, set a value for the FileName property to gain access to the Files stored in the cabinet file.
Call ExtractFile or ExtractAll to perform the desired file operation(s).
About
Contribute to this help topic
This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page
