TElZipReader.OnUserActionNeeded event

TElZipReader.OnUserActionNeeded

This event is fired when user action is needed.

Declaration

[C#]
event TSBZipUserActionNeededEvent OnUserActionNeeded;
delegate void TSBZipUserActionNeededEvent(Object Sender, int ForEvent, string Description, Object Param, ref int UserAction);

[VB.NET]
Event OnUserActionNeeded As TSBZipUserActionNeededEvent
Delegate Sub TSBZipUserActionNeededEvent(ByVal Sender As Object, ByVal ForEvent As Integer, ByVal Description As String, ByVal Param As Object, ByRef UserAction As Integer)

[Pascal]
property OnUserActionNeeded : TSBZipUserActionNeededEvent;
TSBZipUserActionNeededEvent = procedure(Sender: TObject; Entry : TElZipArchiveDirectoryEntry; ForEvent : integer; const Description : string; Param : pointer; var UserAction : integer) of object;

[C++]
    void get_OnUserActionNeeded(TSBZipUserActionNeededEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnUserActionNeeded(TSBZipUserActionNeededEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBZipUserActionNeededEvent)(void * _ObjectData, TObjectHandle Sender, int32_t ForEvent, const char * pcDescription, int32_t szDescription, void * Param, int32_t &UserAction);

[PHP]
    TSBZipUserActionNeededEvent|callable|NULL get_OnUserActionNeeded()
    void set_OnUserActionNeeded(TSBZipUserActionNeededEvent|callable|NULL $Value)
    callable TSBZipUserActionNeededEvent(TObject $Sender, integer $ForEvent, string $Description, TSBPointer|NULL $Param, integer &$UserAction)

[Java]
    TSBZipUserActionNeededEvent getOnUserActionNeeded();
    void setOnUserActionNeeded(TSBZipUserActionNeededEvent Value);
    TSBZipUserActionNeededEvent.Callback OnUserActionNeeded = new TSBZipUserActionNeededEvent.Callback() {
        public void TSBZipUserActionNeededEventCallback(TObject Sender, int ForEvent, String Description, TObject Param, TSBInteger UserAction) {
            //...
        }
    }

Parameters

ForEvent - the event for which the action is needed.
Description - event description.
Param - reference to the object which contains additional information about the archive entry.
UserAction - action chosen by the user.
pcDescription - event description.
szDescription - the length of pcDescription.

Possible events:

[.NET] [Pascal]	[C++]	Value	Description
ZIP_EVENT_EXTRACTION_FAILED	SB_ZIP_EVENT_EXTRACTION_FAILED	4097 (0x1001)	Extraction of one archive entry has failed
ZIP_EVENT_CRC_MISMATCH	SB_ZIP_EVENT_CRC_MISMATCH	4098 (0x1002)	CRC mismatch
ZIP_EVENT_INVALID_PASSWORD	SB_ZIP_EVENT_INVALID_PASSWORD	4099 (0x1003)	Invalid password
ZIP_EVENT_FILE_ALREADY_EXISTS	SB_ZIP_EVENT_FILE_ALREADY_EXISTS	4100 (0x1004)	The file to be extracted already exists
ZIP_EVENT_CANNOT_CREATE_FILE	SB_ZIP_EVENT_CANNOT_CREATE_FILE	4101 (0x1005)	Cannot create file
ZIP_EVENT_DIR_ALREADY_EXISTS	SB_ZIP_EVENT_DIR_ALREADY_EXISTS	4102 (0x1006)	The directory to be extracted already exists
ZIP_EVENT_FILE_ALREADY_ADDED	SB_ZIP_EVENT_FILE_ALREADY_ADDED	4103 (0x1007)	The file is already added

Possible user actions:

[.NET] [Pascal]	[C++]	Value	Description
ZIP_ACTION_IGNORE	SB_ZIP_ACTION_IGNORE	4097 (0x1001)	Ignore event
ZIP_ACTION_ABORT	SB_ZIP_ACTION_ABORT	4098 (0x1002)	Abort action
ZIP_ACTION_RETRY	SB_ZIP_ACTION_RETRY	4099 (0x1003)	Retry action
ZIP_ACTION_SKIP	SB_ZIP_ACTION_SKIP	4100 (0x1004)	Skips the extraction of the file (directory) within ZIP_EVENT_CANNOT_CREATE_FILE, ZIP_EVENT_FILE_ALREADY_EXISTS and ZIP_EVENT_DIR_ALREADY_EXISTS events

Description

This event is fired by TElZipReader when it needs user interaction. User may ignore event, abort extraction or force TElZipReader to retry extraction again.