Click or drag to resize

EngineFilterAsync Method

IT Hit User File System
Allows filtering file system items that should NOT be synched to the remote storage.

Namespace:  ITHit.FileSystem
Assembly:  ITHit.FileSystem (in ITHit.FileSystem.dll) Version: 3.3.9602.0
Syntax
public abstract Task<bool> FilterAsync(
	string userFileSystemPath,
	string userFileSystemNewPath = null
)

Parameters

userFileSystemPath
Type: SystemString
File system item path. In case of move and rename operation this is the source path.
userFileSystemNewPath (Optional)
Type: SystemString
Target file path. This parameter is provided in case of move and rename operation.

Return Value

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

Implements

IEngineFilterAsync(String, String)
Remarks

This method is called before calling GetFileSystemItemAsync(String, FileSystemItemType, Byte) 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 temporary files, system files, Microsoft Office lock files, backup files, etc.

The default Engine implementation returns false for all items.

See Also