TElBZip2Reader.OnArchiveError event

TElBZip2Reader.OnArchiveError

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

Declaration

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

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

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

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

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

[Java]
    TSBBZip2ArchiveErrorEvent getOnArchiveError();
    void setOnArchiveError(TSBBZip2ArchiveErrorEvent Value);
    TSBBZip2ArchiveErrorEvent.Callback OnArchiveError = new TSBBZip2ArchiveErrorEvent.Callback() {
        public void TSBBZip2ArchiveErrorEventCallback(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 TElBZip2Reader to try to overcome the error.
pcErrorMessage - contains textual description of the error.
szErrorMessage - the length of pcErrorMessage.

Error codes:

[.NET] [Pascal]	Value	Description
ZIP_ERROR_CDIR_LOCATOR_CORRUPTED	1 (0x0001)	Failed to find end of central directory record. Local file headers may be used to overcome this error.
ZIP_ERROR_ZIP64_LOCATOR_CORRUPTED	2 (0x0002)	Zip64 end of central directory locator record corrupted or not found.
ZIP_ERROR_ZIP64_END_OF_CDIR_CORRUPTED	3 (0x0003)	Zip64 end of central directory record corrupted or not found.
ZIP_ERROR_CENTRAL_HEADER_CORRUPTED	4 (0x0004)	Central file header corrupted.
ZIP_ERROR_CDIR_NOT_FOUND	5 (0x0005)	Central directory not found.

Description

This event is fired when TElBZip2Reader encounters error during archive reading. It is useful when archives are slightly corrupted, and TElBZip2Reader may try to overcome these errors if user sets the TryContinue parameter to True. Instead of creating the event handler, IgnoreArchiveErrors property may be used.