-
Notifications
You must be signed in to change notification settings - Fork 256
/
ITrackedSaveOperation.xml
59 lines (59 loc) · 3.31 KB
/
ITrackedSaveOperation.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<Type Name="ITrackedSaveOperation" FullName="Microsoft.Azure.Batch.Conventions.Files.ITrackedSaveOperation">
<TypeSignature Language="C#" Value="public interface ITrackedSaveOperation : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract ITrackedSaveOperation implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.Conventions.Files.ITrackedSaveOperation" />
<TypeSignature Language="VB.NET" Value="Public Interface ITrackedSaveOperation
Implements IDisposable" />
<TypeSignature Language="F#" Value="type ITrackedSaveOperation = interface
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch.Conventions.Files</AssemblyName>
<AssemblyVersion>3.5.1.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Represents a tracked save, in which a background operation periodically copies appends
to a file to the corresponding append blob in Azure Storage.
</summary>
<remarks>To be added.</remarks>
<altmember cref="M:Microsoft.Azure.Batch.Conventions.Files.TaskOutputStorage.SaveTrackedAsync(Microsoft.Azure.Batch.Conventions.Files.TaskOutputKind,System.String,System.String,System.TimeSpan)" />
</Docs>
<Members>
<Member MemberName="FlushError">
<MemberSignature Language="C#" Value="event EventHandler<Exception> FlushError;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class System.Exception> FlushError" />
<MemberSignature Language="DocId" Value="E:Microsoft.Azure.Batch.Conventions.Files.ITrackedSaveOperation.FlushError" />
<MemberSignature Language="VB.NET" Value="Event FlushError As EventHandler(Of Exception) " />
<MemberSignature Language="F#" Value="member this.FlushError : EventHandler<Exception> " Usage="member this.FlushError : System.EventHandler<System.Exception> " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch.Conventions.Files</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler<System.Exception></ReturnType>
</ReturnValue>
<Docs>
<summary>
Occurs when there is an error while performing a background append to the blob in Azure Storage.
</summary>
<remarks>
<para>
If an error occurs while appending, the 'last position' is not updated, so the data that
could not be appended will be included in the next flush.
</para>
<para>
This event is not raised if an error occurs during <see cref="M:System.IDisposable.Dispose" />; instead,
the Dispose method method re-throws the exception directly. In this case, the background
appends are no longer running, so it is up to the calling code to decide whether and how to
save the unflushed data (for example, re-saving the file using the non-tracking methods).
</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>