ExFTPConnectionSynchronize Method (String, String, FTPSyncRules) |
Synchronizes the given local directory with the given remote directory
according to the given synchronization rules.
Namespace:
EnterpriseDT.Net.Ftp
Assembly:
edtFTPnetPRO (in edtFTPnetPRO.dll) Version: 12.3.0.0
Syntaxpublic FTPSyncResults Synchronize(
string localDirectory,
string serverDirectory,
FTPSyncRules syncRules
)
Public Function Synchronize (
localDirectory As String,
serverDirectory As String,
syncRules As FTPSyncRules
) As FTPSyncResults
public:
FTPSyncResults^ Synchronize(
String^ localDirectory,
String^ serverDirectory,
FTPSyncRules^ syncRules
)
member Synchronize :
localDirectory : string *
serverDirectory : string *
syncRules : FTPSyncRules -> FTPSyncResults
Parameters
- localDirectory
- Type: SystemString
Directory on the local machine to synchronize.
If this argument is null then [!:LocalDirectory] will be used. - serverDirectory
- Type: SystemString
Directory on the server to synchronize.
If this argument is null then [!:ServerDirectory] will be used. - syncRules
- Type: EnterpriseDT.Net.FtpFTPSyncRules
Rules to apply to the synchronization operation.
If this argument is null then DefaultSyncRules will be used.
Return Value
Type:
FTPSyncResults[!:FTPSyncReport] containing results of synchronization operation
RemarksSynchronization aims to ensure that the files in a directory
on the local machine match those in a directory on the remote machine.
The instructions contained in FTPSyncRules inform
the synchronization process how files should be matched. If these rules
are insufficient then the SynchronizingFile event may be used
to provide customized logic for matching files.
The Synchronizing and Synchronized events
are triggered before and after the synchronization operation is performed,
respectively.
See Also