TElTarReader.OnUserActionNeeded event

TElTarReader.OnUserActionNeeded

This event is fired when user action is needed.

Declaration

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

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

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

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

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

[Java]
    TSBTarUserActionNeededEvent getOnUserActionNeeded();
    void setOnUserActionNeeded(TSBTarUserActionNeededEvent Value);
    TSBTarUserActionNeededEvent.Callback OnUserActionNeeded = new TSBTarUserActionNeededEvent.Callback() {
        public void TSBTarUserActionNeededEventCallback(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
TAR_EVENT_EXTRACTION_FAILED	SB_TAR_EVENT_EXTRACTION_FAILED	4097 (0x1001)	Extraction of one archive entry has failed
TAR_EVENT_FILE_ALREADY_EXISTS	SB_TAR_EVENT_FILE_ALREADY_EXISTS	4098 (0x1002)	The file to be extracted already exists
TAR_EVENT_CANNOT_CREATE_FILE	SB_TAR_EVENT_CANNOT_CREATE_FILE	4099 (0x1003)	Cannot create file
TAR_EVENT_DIR_ALREADY_EXISTS	SB_TAR_EVENT_DIR_ALREADY_EXISTS	4100 (0x1004)	The directory to be extracted already exists
TAR_EVENT_FILE_ALREADY_ADDED	SB_TAR_EVENT_FILE_ALREADY_ADDED	4101 (0x1005)	The file is already added
TAR_EVENT_CRC_MISMATCH	SB_TAR_EVENT_CRC_MISMATCH	4102 (0x1006)	CRC mismatch

Possible user actions:

[.NET] [Pascal]	[C++]	Value	Description
TAR_ACTION_IGNORE	SB_TAR_ACTION_IGNORE	4097 (0x1001)	Ignore event
TAR_ACTION_ABORT	SB_TAR_ACTION_ABORT	4098 (0x1002)	Abort action
TAR_ACTION_RETRY	SB_TAR_ACTION_RETRY	4099 (0x1003)	Retry action
TAR_ACTION_SKIP	SB_TAR_ACTION_SKIP	4100 (0x1004)	Skips the extraction of the file (directory) within TAR_EVENT_CANNOT_CREATE_FILE, TAR_EVENT_FILE_ALREADY_EXISTS and TAR_EVENT_DIR_ALREADY_EXISTS events

Description

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