-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
StreamInfo.xml
259 lines (249 loc) · 14.7 KB
/
StreamInfo.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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
<Type Name="StreamInfo" FullName="System.IO.Packaging.StreamInfo">
<TypeSignature Language="C#" Value="public class StreamInfo" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit StreamInfo extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.IO.Packaging.StreamInfo" />
<TypeSignature Language="VB.NET" Value="Public Class StreamInfo" />
<TypeSignature Language="F#" Value="type StreamInfo = class" />
<TypeSignature Language="C++ CLI" Value="public ref class StreamInfo" />
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides access and information for manipulating I/O streams within a <see cref="T:System.IO.Packaging.Package" />.</summary>
<remarks>To be added.</remarks>
<altmember cref="M:System.IO.Packaging.StorageInfo.CreateStream(System.String,System.IO.Packaging.CompressionOption,System.IO.Packaging.EncryptionOption)" />
<altmember cref="M:System.IO.Packaging.StorageInfo.DeleteStream(System.String)" />
<altmember cref="M:System.IO.Packaging.StorageInfo.GetStreamInfo(System.String)" />
<altmember cref="M:System.IO.Packaging.StorageInfo.GetStreams" />
<altmember cref="M:System.IO.Packaging.StorageInfo.StreamExists(System.String)" />
</Docs>
<Members>
<Member MemberName="CompressionOption">
<MemberSignature Language="C#" Value="public System.IO.Packaging.CompressionOption CompressionOption { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.IO.Packaging.CompressionOption CompressionOption" />
<MemberSignature Language="DocId" Value="P:System.IO.Packaging.StreamInfo.CompressionOption" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CompressionOption As CompressionOption" />
<MemberSignature Language="F#" Value="member this.CompressionOption : System.IO.Packaging.CompressionOption" Usage="System.IO.Packaging.StreamInfo.CompressionOption" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IO::Packaging::CompressionOption CompressionOption { System::IO::Packaging::CompressionOption get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Packaging.CompressionOption</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.IO.Packaging.CompressionOption" /> setting for the stream.</summary>
<value>The compression option setting for the package stream.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If <xref:System.Windows.FreezableCollection%601.Enumerator.System%23IDisposable%23Dispose%2A> has been called on the stream, the <xref:System.IO.Packaging.StreamInfo.CompressionOption%2A> property returns CompressionOption.<xref:System.IO.Packaging.CompressionOption.NotCompressed>.
]]></format>
</remarks>
<altmember cref="Overload:System.IO.Packaging.StorageInfo.CreateStream" />
<altmember cref="Overload:System.IO.Packaging.StreamInfo.GetStream" />
</Docs>
</Member>
<Member MemberName="EncryptionOption">
<MemberSignature Language="C#" Value="public System.IO.Packaging.EncryptionOption EncryptionOption { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.IO.Packaging.EncryptionOption EncryptionOption" />
<MemberSignature Language="DocId" Value="P:System.IO.Packaging.StreamInfo.EncryptionOption" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EncryptionOption As EncryptionOption" />
<MemberSignature Language="F#" Value="member this.EncryptionOption : System.IO.Packaging.EncryptionOption" Usage="System.IO.Packaging.StreamInfo.EncryptionOption" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IO::Packaging::EncryptionOption EncryptionOption { System::IO::Packaging::EncryptionOption get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Packaging.EncryptionOption</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.IO.Packaging.EncryptionOption" /> setting for the stream.</summary>
<value>The encryption option setting for the package stream.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If <xref:System.Windows.FreezableCollection%601.Enumerator.System%23IDisposable%23Dispose%2A> has been called on the stream, the <xref:System.IO.Packaging.StreamInfo.EncryptionOption%2A> property returns EncryptionOption.<xref:System.IO.Packaging.EncryptionOption.None>.
]]></format>
</remarks>
<altmember cref="Overload:System.IO.Packaging.StorageInfo.CreateStream" />
<altmember cref="Overload:System.IO.Packaging.StreamInfo.GetStream" />
</Docs>
</Member>
<MemberGroup MemberName="GetStream">
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Opens and returns the I/O stream for the <see cref="T:System.IO.Packaging.Package" /> root.</summary>
<altmember cref="Overload:System.IO.Packaging.StorageInfo.CreateStream" />
</Docs>
</MemberGroup>
<Member MemberName="GetStream">
<MemberSignature Language="C#" Value="public System.IO.Stream GetStream ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.IO.Stream GetStream() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Packaging.StreamInfo.GetStream" />
<MemberSignature Language="VB.NET" Value="Public Function GetStream () As Stream" />
<MemberSignature Language="F#" Value="member this.GetStream : unit -> System.IO.Stream" Usage="streamInfo.GetStream " />
<MemberSignature Language="C++ CLI" Value="public:
 System::IO::Stream ^ GetStream();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Stream</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a stream opened in a default <see cref="T:System.IO.FileMode" /> and <see cref="T:System.IO.FileAccess" />.</summary>
<returns>The I/O stream opened in a default <see cref="T:System.IO.Packaging.Package" /> root <see cref="T:System.IO.FileMode" /> and <see cref="T:System.IO.FileAccess" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This <xref:System.IO.Packaging.StreamInfo.GetStream%2A> method (without parameters), opens the stream in file mode <xref:System.IO.FileMode.OpenOrCreate> with the default storage root <xref:System.IO.FileAccess>.
]]></format>
</remarks>
<altmember cref="Overload:System.IO.Packaging.StorageInfo.CreateStream" />
</Docs>
</Member>
<Member MemberName="GetStream">
<MemberSignature Language="C#" Value="public System.IO.Stream GetStream (System.IO.FileMode mode);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.IO.Stream GetStream(valuetype System.IO.FileMode mode) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Packaging.StreamInfo.GetStream(System.IO.FileMode)" />
<MemberSignature Language="VB.NET" Value="Public Function GetStream (mode As FileMode) As Stream" />
<MemberSignature Language="F#" Value="member this.GetStream : System.IO.FileMode -> System.IO.Stream" Usage="streamInfo.GetStream mode" />
<MemberSignature Language="C++ CLI" Value="public:
 System::IO::Stream ^ GetStream(System::IO::FileMode mode);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Stream</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="mode" Type="System.IO.FileMode" />
</Parameters>
<Docs>
<param name="mode">The file mode in which to open the stream.</param>
<summary>Returns an I/O stream opened in a specified <see cref="T:System.IO.FileMode" />.</summary>
<returns>The stream opened in the specified file <paramref name="mode" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This <xref:System.IO.Packaging.StreamInfo.GetStream%2A> method opens the stream with the default storage root <xref:System.IO.FileAccess>.
]]></format>
</remarks>
<altmember cref="Overload:System.IO.Packaging.StorageInfo.CreateStream" />
</Docs>
</Member>
<Member MemberName="GetStream">
<MemberSignature Language="C#" Value="public System.IO.Stream GetStream (System.IO.FileMode mode, System.IO.FileAccess access);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.IO.Stream GetStream(valuetype System.IO.FileMode mode, valuetype System.IO.FileAccess access) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Packaging.StreamInfo.GetStream(System.IO.FileMode,System.IO.FileAccess)" />
<MemberSignature Language="VB.NET" Value="Public Function GetStream (mode As FileMode, access As FileAccess) As Stream" />
<MemberSignature Language="F#" Value="member this.GetStream : System.IO.FileMode * System.IO.FileAccess -> System.IO.Stream" Usage="streamInfo.GetStream (mode, access)" />
<MemberSignature Language="C++ CLI" Value="public:
 System::IO::Stream ^ GetStream(System::IO::FileMode mode, System::IO::FileAccess access);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Stream</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="mode" Type="System.IO.FileMode" />
<Parameter Name="access" Type="System.IO.FileAccess" />
</Parameters>
<Docs>
<param name="mode">The file mode in which to open the stream.</param>
<param name="access">The file access mode in which to read or write to the stream.</param>
<summary>Returns an I/O stream opened in a specified <see cref="T:System.IO.FileMode" /> and with a given <see cref="T:System.IO.FileAccess" />.</summary>
<returns>The I/O stream opened in the specified <see cref="T:System.IO.FileMode" /> and with a given <see cref="T:System.IO.FileAccess" />.</returns>
<remarks>To be added.</remarks>
<altmember cref="Overload:System.IO.Packaging.StorageInfo.CreateStream" />
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:System.IO.Packaging.StreamInfo.Name" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="System.IO.Packaging.StreamInfo.Name" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Name { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the name of the stream.</summary>
<value>The name of this stream.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If <xref:System.Windows.FreezableCollection%601.Enumerator.System%23IDisposable%23Dispose%2A> has been called on the stream, the <xref:System.IO.Packaging.StreamInfo.Name%2A> property returns an empty string.
]]></format>
</remarks>
<altmember cref="Overload:System.IO.Packaging.StorageInfo.CreateStream" />
</Docs>
</Member>
</Members>
</Type>