JVCL Help:TJvCABFile.OnFileExtracted
JVCL Help: TJvCABFile.OnFileExtracted Event
Search in JVCL Help
Search in all projectsSummary
Occurs after a file has been extracted from the cabinet file.
Pascal
TOnExtracted = procedure (Sender: TObject; Successed: Boolean; var Cont: Boolean; Source, Dest: string) ofobject;
propertyOnFileExtracted: TOnExtracted;
Parameters
| Parameters | Description |
| Source | Source file name extracted from the Cabinet file. |
| Dest | Destination file name created for the extracted file. |
| Cont | Indicates whether file extraction can be continued. |
| Sender | Object context for the event notification. Generally contains the TJvCABFile instance to be signaled from the callback function. |
| Successed | Indicates whether the file was successfully extracted. |
Description
OnFileExtracted is a TOnExtracted property that represents the event handler signaled when a file has been extracted from the cabinet file using the Setup API. OnFileExtracted is signaled when the SPFILENOTIFY_FILEEXTRACTED notification is received in the internal extraction callback function after a call to ExtractFile or ExtractAll.
OnFileExtracted can be used to detect when the extraction is complete, or when a Win32 error has occurred during the Setup API function calls. The OnFileExtracted event handler can also be used to halt extraction of additional files, during execution of the ExtractAll method, by setting the Cont argument to False.
Successed is Boolean value that indicates if a Win32 error occurred while trying to build a file listing or extract the file specified in Source. Successed contains True if a Win32 error has not been detected.
Cont is a Boolean parameter that indicates if the Setup API can or should continue to extract files from the cabinet file. The default value for Cont is True, unless a Win32 error occurs in the Setup API or the event handler changes the value to False.
Applications must assign a procedure to the event handler to allow responding to the event notification.
See Also
TJvCABFile.ExtractFile, 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
