Click or drag to resize

IFileWriteAsync Method

IT Hit User File System
Updates this file in the remote storage.

Namespace:  ITHit.FileSystem
Assembly:  ITHit.FileSystem (in ITHit.FileSystem.dll) Version: 8.4.27341.0
Syntax
Task<IFileMetadata> WriteAsync(
	IFileMetadata metadata,
	Stream content = null,
	IOperationContext operationContext = null,
	IInSyncResultContext inSyncResultContext = null,
	CancellationToken cancellationToken = null
)

Parameters

metadata
Type: ITHit.FileSystemIFileMetadata
content (Optional)
Type: System.IOStream
New file content or null if the file content is not modified.
operationContext (Optional)
Type: ITHit.FileSystemIOperationContext
Provides information about the environment.
inSyncResultContext (Optional)
Type: ITHit.FileSystemIInSyncResultContext
If the SetInSync property is set to true the item is marked as in-sync. Otherwise the item remains in the not in-sync state. The SetInSync property is true by default.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The token to monitor for cancellation requests.

Return Value

Type: TaskIFileMetadata
Updated item. In the returned data set the following fields:
  • Content eTag. The Engine will store it to determine if the file content should be updated.
  • Medatdata eTag. The Engine will store it to determine if the item metadata should be updated.
Remarks

If this method completes without exceptions and the SetInSync property of the inSyncResultContext parameter is set to true the item is marked as in-sync when the operation completes. Otherwise, the item is left in the not in-sync state.

Setting the SetInSync property of the inSyncResultContext parameter to false has the same affect as throwing an exception inside this method.

See Also