JVCL Help:TJvCABFile.OnNeedNewCabinet

From Project JEDI Wiki
Jump to navigationJump to search
JEDI Visual Component Library Help

Search in JVCL Help

 
Search in all projects
 

Summary

Occurs when a specific file continues in another cabinet.


Pascal

 TOnNeedNewCabinet = procedure (Sender: TObject; var Cont: Boolean; CABInfo: TCABInfo; var NewPath: string) ofobject;
propertyOnNeedNewCabinet: TOnNeedNewCabinet;


Parameters

Parameters Description
CABInfo Structure used to store cabinet file information from the Setup API.
NewPath Path to use for files extracted from the new .CAB file.
Sender Object context for the event notification. Generally contains the TJvCABFile instance to be signaled from the callback function.
Cont Indicates whether file extraction can be continued.


Description

OnNeedNewCabinet is a TOnNeedNewCabinet property that represents the event handler signaled when a specific file continues in another cabinet file. OnNeedNewCabinet is signaled in the internal callback function for the Setup API when the SPFILENOTIFY_NEEDNEWCABINET notification is sent during iteration over file members in a .CAB file. OnNeedNewCabinet can be used to allow an application to respond to the disk or path changes need to access the new cabinet file prior to continuing the file operation. The file operation can be abandoned by setting the value in the Cont argument to false in the event handler. Cont is a Boolean parameter that indicates if the Setup API can or should continue to extract files from the new 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