TElTarReader.OnArchiveError event

TElTarReader.OnArchiveError

This event is fired when an error occurs during archive reading.

Declaration

[C#]
event TSBTarArchiveErrorEvent OnArchiveError;
delegate void TSBTarArchiveErrorEvent(Object Sender, int ErrorCode, string ErrorMessage, ref bool TryContinue);

[VB.NET]
Event OnArchiveError As TSBTarArchiveErrorEvent
Delegate Sub TSBTarArchiveErrorEvent(ByVal Sender As Object, ByVal ErrorCode As Integer, ByVal ErrorMessage As String, ByRef TryContinue As Boolean)

[Pascal]
property OnArchiveError : TSBTarArchiveErrorEvent;
TSBTarArchiveErrorEvent = procedure(Sender : TObject; ErrorCode : integer; const ErrorMessage : string; var TryContinue : boolean) of object;

[C++]
    void get_OnArchiveError(TSBTarArchiveErrorEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnArchiveError(TSBTarArchiveErrorEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBTarArchiveErrorEvent)(void * _ObjectData, TObjectHandle Sender, int32_t ErrorCode, const char * pcErrorMessage, int32_t szErrorMessage, int8_t &TryContinue);

[PHP]
    TSBTarArchiveErrorEvent|callable|NULL get_OnArchiveError()
    void set_OnArchiveError(TSBTarArchiveErrorEvent|callable|NULL $Value)
    callable TSBTarArchiveErrorEvent(TObject $Sender, integer $ErrorCode, string $ErrorMessage, bool &$TryContinue)

[Java]
    TSBTarArchiveErrorEvent getOnArchiveError();
    void setOnArchiveError(TSBTarArchiveErrorEvent Value);
    TSBTarArchiveErrorEvent.Callback OnArchiveError = new TSBTarArchiveErrorEvent.Callback() {
        public void TSBTarArchiveErrorEventCallback(TObject Sender, int ErrorCode, String ErrorMessage, TSBBoolean TryContinue) {
            //...
        }
    }

Parameters

ErrorCode - specifies the error code.
ErrorMessage - contains textual description of the error.
TryContinue - set this parameter to True if you want TElTarReader to try to overcome the error.
pcErrorMessage - contains textual description of the error.
szErrorMessage - the length of pcErrorMessage.

Error codes:

Definition	Value	Description
TAR_ERROR_HEADERSIZE_CORRUPTED	1 (0x0001)	File header size is wrong
TAR_ERROR_HEADER_CORRUPTED	2 (0x0002)	File header is corrupted
TAR_ERROR_USTARSIZE_CORRUPTED	3 (0x0003)	USTar size is wrong
TAR_ERROR_CHECKSUM_CORRUPTED	4 (0x0004)	File check sum is corrupted

Description

This event is fired when TElTarReader encounters an error during archive reading. If the archive is only lightly corrupted, TElTarReader may try to overcome these errors, if TryContinue parameter is set to true. Instead of creating the event handler, IgnoreArchiveErrors property may be used.