Discuss this help topic in SecureBlackbox Forum

TElPOP3Client.OnProgress

TElPOP3Client     See also     


Filter: C#/Java  VB.NET  Pascal  C++  PHP  


This event is fired when an email message is being retrieved from server.

Declaration

[C#/Java]
    event TSBProgressEvent OnProgress;
    delegate void TSBProgressEvent(Object Sender, long Total, long Current, ref bool Cancel);

[VB.NET]
    Event OnProgress As TSBProgressEvent
    Delegate Sub TSBProgressEvent(ByVal Sender As Object, ByVal Total As Long, ByVal Current As Long, ByRef Cancel As Boolean)

[Pascal]
    property OnProgress : TSBProgressEvent;
    TSBProgressEvent = procedure(Sender : TObject; Total, Current : Int64; var Cancel : boolean) of object;

[C++]
    void get_OnProgress(TSBProgressEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnProgress(TSBProgressEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBProgressEvent)(void * _ObjectData, TObjectHandle Sender, int64_t Total, int64_t Current, int8_t &Cancel);

[PHP]
    TSBProgressEvent|callable|NULL get_OnProgress()
    void set_OnProgress(TSBProgressEvent|callable|NULL $Value)
    callable TSBProgressEvent(TObject $Sender, integer $Total, integer $Current, bool &$Cancel)

Parameters

  • Total - total number of bytes to be downloaded.
  • Current - specifies how much data has been downloaded already.
  • Cancel - allows to cancel the operation.

Description

    This event is fired by ReceiveMessage to show the progress of message download.

See also:     ReceiveMessage    

Discuss this help topic in SecureBlackbox Forum