Click or drag to resize

EngineFilterAsync Method

IT Hit User File System
Allows filtering file system items.

Namespace:  ITHit.FileSystem
Assembly:  ITHit.FileSystem (in ITHit.FileSystem.dll) Version: 8.4.27341.0
Syntax
Copy
public abstract Task<bool> FilterAsync(
	SyncDirection direction,
	OperationType operationType,
	string userFileSystemPath,
	FileSystemItemType itemType,
	string userFileSystemNewPath,
	IOperationContext operationContext
)

Parameters

direction
Type: ITHit.FileSystemSyncDirection
Indicates synchronization direction.
operationType
Type: ITHit.FileSystemOperationType
File system operation type: OperationType.
userFileSystemPath
Type: SystemString
itemType
Type: ITHit.FileSystemFileSystemItemType
Item type - file or folder.
userFileSystemNewPath
Type: SystemString
operationContext
Type: ITHit.FileSystemIOperationContext
Provides additonal information if available, depending on the environment.

Return Value

Type: TaskBoolean
True if the item must NOT be synced to the remote storage. False - otherwise.

Implements

IFileSystemFilterFilterAsync(SyncDirection, OperationType, String, FileSystemItemType, String, IOperationContext)
Remarks

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.

See Also