TElSimpleFTPSClient.OnFileNameChangeNeeded event

TElSimpleFTPSClient.OnFileNameChangeNeeded

This event is fired when a file needs to be renamed.

Declaration

[C#]
event TSBFTPSFileNameChangeNeededEvent OnFileNameChangeNeeded;
delegate void TSBFTPSFileNameChangeNeededEvent(Object Sender, ref string FileName, ref bool Force);

[VB.NET]
Event OnFileNameChangeNeeded As TSBFTPSFileNameChangeNeededEvent
Delegate Sub TSBFTPSFileNameChangeNeededEvent(ByVal Sender As Object, ByRef FileName As String, ByRef Force As Boolean)

[Pascal]
property OnFileNameChangeNeeded: TSBFileNameChangeNeededEvent;
TSBFileNameChangeNeededEvent = procedure(Sender : TObject; var FileName : string; var Force : boolean) of object;

[C++]
    void get_OnFileNameChangeNeeded(TSBFTPSFileNameChangeNeededEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnFileNameChangeNeeded(TSBFTPSFileNameChangeNeededEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBFTPSFileNameChangeNeededEvent)(void * _ObjectData, TObjectHandle Sender, char * pcFileName, int32_t &szFileName, int8_t &Force);

[PHP]
    TSBFTPSFileNameChangeNeededEvent|callable|NULL get_OnFileNameChangeNeeded()
    void set_OnFileNameChangeNeeded(TSBFTPSFileNameChangeNeededEvent|callable|NULL $Value)
    callable TSBFTPSFileNameChangeNeededEvent(TObject $Sender, string &$FileName, bool &$Force)

[Java]
    TSBFTPSFileNameChangeNeededEvent getOnFileNameChangeNeeded();
    void setOnFileNameChangeNeeded(TSBFTPSFileNameChangeNeededEvent Value);
    TSBFTPSFileNameChangeNeededEvent.Callback OnFileNameChangeNeeded = new TSBFTPSFileNameChangeNeededEvent.Callback() {
        public void TSBFTPSFileNameChangeNeededEventCallback(TObject Sender, String[] FileName, TSBBoolean Force) {
            //...
        }
    }

Parameters

FileName - the new name for the file has to be passed via this parameter. When an empty string is passed, the operation is cancelled.
Force - set this property to True to force rename.
pcFileName - the new name for the file has to be passed via this parameter. When an empty string is passed, the operation is cancelled.
szFileName - the length of pcFileName.

Description

This event is fired by TElSimpleFTPSClient from DownloadFiles and UploadFiles methods when the component has encountered a file with the same name aither locally or on the server side. Depending on the file transfer mode, one of the files needs to be renamed. The handler should provide new file name via the corresponding parameter; when an empty string is passed, the operation is cancelled.