IT Hit User File System
Updates this file in the remote storage.
Namespace:
ITHit.FileSystem
Assembly:
ITHit.FileSystem (in ITHit.FileSystem.dll) Version: 8.3.27213.0
Syntax Task<IFileMetadata> WriteAsync(
IFileMetadata metadata,
Stream content = null,
IOperationContext operationContext = null,
IInSyncResultContext inSyncResultContext = null,
CancellationToken cancellationToken = null
)
Function WriteAsync (
metadata As IFileMetadata,
Optional content As Stream = Nothing,
Optional operationContext As IOperationContext = Nothing,
Optional inSyncResultContext As IInSyncResultContext = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IFileMetadata)
Task<IFileMetadata^>^ WriteAsync(
IFileMetadata^ metadata,
Stream^ content = nullptr,
IOperationContext^ operationContext = nullptr,
IInSyncResultContext^ inSyncResultContext = nullptr,
CancellationToken cancellationToken = nullptr
)
abstract WriteAsync :
metadata : IFileMetadata *
?content : Stream *
?operationContext : IOperationContext *
?inSyncResultContext : IInSyncResultContext *
?cancellationToken : CancellationToken
(* Defaults:
let _content = defaultArg content null
let _operationContext = defaultArg operationContext null
let _inSyncResultContext = defaultArg inSyncResultContext null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<IFileMetadata>
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