JVCL Help:TJvCABFile.ExtractFile
JVCL Help: TJvCABFile.ExtractFile Method
Search in JVCL Help
Search in all projectsSummary
Extracts a specific file to a destination path.
Pascal
functionExtractFile(FileName: string; DestPath: string): Boolean;
Parameters
| Parameters | Description |
| FileName: string | File name to extract from the cabinet file. |
| DestPath: string | Path to use for storing the extracted file. |
Return Value
The return value for ExtractFile is True when SetupIterateCabinet completes successfully, or False if FileName does not exist or another Win32 error is encountered in the callback function.
Description
ExtractFile is a Boolean function that extracts the specified file in the cabinet file to a destination path. FileName is a file name, as represented in Files, to extract from the cabinet file. DestPath indicates the disk path to use for storing the extracted file contents.
ExtractFile insures that DestPath has a trailing path delimiter, and appends the FileName argument to form a full path and file name for the extracted file. ExtractFile stores the complete path and file name value in the internal member variable reserved for that purpose.
ExtractFile calls the SetupIterateCabinet function from the Setup API using the cabinet file identified in the FileName property and the internal callback function for file extraction.
Use Files to access the file names stored in the cabinet file identified by the FileName property.
Use ExtractAll to extract all files from the cabinet file identified in the FileName property to a specific destination path.
See Also
TJvCABFile.Files, TJvCABFile.FileName, TJvCABFile.ExtractAll
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
