TElBZip2Reader.OnUserActionNeeded event

TElBZip2Reader.OnUserActionNeeded

This event is fired when user action is needed.

Declaration

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

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

[Pascal]
property OnUserActionNeeded : TSBBzip2UserActionNeededEvent;
TSBBzip2UserActionNeededEvent = procedure(Sender : TObject; ForEvent : integer; const Description : string; var UserAction : integer) of object;

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

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

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

Parameters

ForEvent - the event for which the action is needed.
Description - event description.
UserAction - action chosen by the user.
pcDescription - event description.
szDescription - the length of pcDescription.

Possible events:

[.NET] [Pascal]	[C++]	Value	Description
BZIP_EVENT_EXTRACTION_FAILED	SB_BZIP_EVENT_EXTRACTION_FAILED	4097 (0x1001)	Extraction of the file has failed
BZIP_EVENT_FILE_ALREADY_EXISTS	SB_BZIP_EVENT_FILE_ALREADY_EXISTS	4098 (0x1002)	The file to be extracted already exists
BZIP_EVENT_CANNOT_CREATE_FILE	SB_BZIP_EVENT_CANNOT_CREATE_FILE	4099 (0x1003)	Cannot create file
BZIP_EVENT_DIR_ALREADY_EXISTS	SB_BZIP_EVENT_DIR_ALREADY_EXISTS	4100 (0x1004)	The directory to be extracted already exists
BZIP_EVENT_FILE_ALREADY_ADDED	SB_BZIP_EVENT_FILE_ALREADY_ADDED	4101 (0x1005)	The file is already added
BZIP_EVENT_CRC_MISMATCH	SB_BZIP_EVENT_CRC_MISMATCH	4102 (0x1006)	CRC mismatch

Possible user actions:

[.NET] [Pascal]	[C++]	Value	Description
BZIP_ACTION_IGNORE	SB_BZIP_ACTION_IGNORE	4097 (0x1001)	Ignore event
BZIP_ACTION_ABORT	SB_BZIP_ACTION_ABORT	4098 (0x1002)	Abort action
BZIP_ACTION_RETRY	SB_BZIP_ACTION_RETRY	4099 (0x1003)	Retry action
BZIP_ACTION_SKIP	SB_BZIP_ACTION_SKIP	4100 (0x1004)	Skips the extraction of the file (directory) within BZIP_EVENT_CANNOT_CREATE_FILE, BZIP_EVENT_FILE_ALREADY_EXISTS and BZIP_EVENT_DIR_ALREADY_EXISTS events

Description

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