IFileSystemFilterFilterAsync Method

Task<bool> FilterAsync(
	SyncDirection direction,
	OperationType operationType,
	string path,
	FileSystemItemType itemType,
	string newPath,
	IOperationContext operationContext
)

Function FilterAsync ( 
	direction As SyncDirection,
	operationType As OperationType,
	path As String,
	itemType As FileSystemItemType,
	newPath As String,
	operationContext As IOperationContext
) As Task(Of Boolean)

Task<bool>^ FilterAsync(
	SyncDirection direction, 
	OperationType operationType, 
	String^ path, 
	FileSystemItemType itemType, 
	String^ newPath, 
	IOperationContext^ operationContext
)

abstract FilterAsync : 
        direction : SyncDirection * 
        operationType : OperationType * 
        path : string * 
        itemType : FileSystemItemType * 
        newPath : string * 
        operationContext : IOperationContext -> Task<bool> 

Parameters

direction

Type: ITHit.FileSystemSyncDirection
Indicates synchronization direction.

operationType

Type: ITHit.FileSystemOperationType
File system operation type: OperationType.

path

Type: SystemString
File system item path. In case of move and rename operation this is the source path.

itemType

Type: ITHit.FileSystemFileSystemItemType
Item type - file or folder.

newPath

Type: SystemString
Target file path. This parameter is provided only in case of Move and MoveCompletion operation. It is null for all other operations.

operationContext

Type: ITHit.FileSystemIOperationContext
Provides additonal information if available, depending on the environment.

Return Value

This method is called before calling GetFileSystemItemAsync(Byte, FileSystemItemType, IContext, ILogger) as well as each IFile, IFolder and ILock interface methods. If this method returns true, the method is NOT called.

You can use this method to exclude items from synchronization with the remote storage. For example you can exclude temporary files, hidden files, Microsoft Office lock files, backup files, etc.

The default Engine implementation returns false for all items.

Reference