Merge pull request #938 from exony-craigminihan/bugzilla#18245
[mono.git] / mcs / class / corlib / Documentation / en / System.Runtime.Serialization.Formatters.Binary / BinaryFormatter.xml
1 <Type Name="BinaryFormatter" FullName="System.Runtime.Serialization.Formatters.Binary.BinaryFormatter">
2   <TypeSignature Maintainer="auto" Language="C#" Value="public sealed class BinaryFormatter : System.Runtime.Remoting.Messaging.IRemotingFormatter" />
3   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit BinaryFormatter extends System.Object implements class System.Runtime.Remoting.Messaging.IRemotingFormatter, class System.Runtime.Serialization.IFormatter" />
4   <AssemblyInfo>
5     <AssemblyName>mscorlib</AssemblyName>
6     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
7     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
8     <AssemblyVersion>2.0.0.0</AssemblyVersion>
9     <AssemblyVersion>4.0.0.0</AssemblyVersion>
10   </AssemblyInfo>
11   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
12   <Base>
13     <BaseTypeName>System.Object</BaseTypeName>
14   </Base>
15   <Interfaces>
16     <Interface>
17       <InterfaceName>System.Runtime.Remoting.Messaging.IRemotingFormatter</InterfaceName>
18     </Interface>
19   </Interfaces>
20   <Attributes>
21     <Attribute>
22       <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
23     </Attribute>
24   </Attributes>
25   <Docs>
26     <summary>To be added</summary>
27     <remarks>To be added</remarks>
28   </Docs>
29   <Members>
30     <Member MemberName=".ctor">
31       <MemberSignature Language="C#" Value="public BinaryFormatter ();" />
32       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
33       <MemberType>Constructor</MemberType>
34       <AssemblyInfo>
35         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
36         <AssemblyVersion>2.0.0.0</AssemblyVersion>
37         <AssemblyVersion>4.0.0.0</AssemblyVersion>
38       </AssemblyInfo>
39       <ReturnValue />
40       <Parameters />
41       <Docs>
42         <summary>To be added</summary>
43         <remarks>To be added</remarks>
44       </Docs>
45     </Member>
46     <Member MemberName=".ctor">
47       <MemberSignature Language="C#" Value="public BinaryFormatter (System.Runtime.Serialization.ISurrogateSelector selector, System.Runtime.Serialization.StreamingContext context);" />
48       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Runtime.Serialization.ISurrogateSelector selector, valuetype System.Runtime.Serialization.StreamingContext context) cil managed" />
49       <MemberType>Constructor</MemberType>
50       <AssemblyInfo>
51         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
52         <AssemblyVersion>2.0.0.0</AssemblyVersion>
53         <AssemblyVersion>4.0.0.0</AssemblyVersion>
54       </AssemblyInfo>
55       <ReturnValue />
56       <Parameters>
57         <Parameter Name="selector" Type="System.Runtime.Serialization.ISurrogateSelector" />
58         <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
59       </Parameters>
60       <Docs>
61         <param name="selector">To be added: an object of type 'Runtime.Serialization.ISurrogateSelector'</param>
62         <param name="context">To be added: an object of type 'Runtime.Serialization.StreamingContext'</param>
63         <summary>To be added</summary>
64         <remarks>To be added</remarks>
65       </Docs>
66     </Member>
67     <Member MemberName="AssemblyFormat">
68       <MemberSignature Language="C#" Value="public System.Runtime.Serialization.Formatters.FormatterAssemblyStyle AssemblyFormat { get; set; }" />
69       <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Runtime.Serialization.Formatters.FormatterAssemblyStyle AssemblyFormat" />
70       <MemberType>Property</MemberType>
71       <AssemblyInfo>
72         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
73         <AssemblyVersion>2.0.0.0</AssemblyVersion>
74         <AssemblyVersion>4.0.0.0</AssemblyVersion>
75       </AssemblyInfo>
76       <ReturnValue>
77         <ReturnType>System.Runtime.Serialization.Formatters.FormatterAssemblyStyle</ReturnType>
78       </ReturnValue>
79       <Docs>
80         <summary>To be added.</summary>
81         <value>To be added.</value>
82         <remarks>To be added.</remarks>
83       </Docs>
84     </Member>
85     <Member MemberName="Binder">
86       <MemberSignature Language="C#" Value="public System.Runtime.Serialization.SerializationBinder Binder { get; set; }" />
87       <MemberSignature Language="ILAsm" Value=".property instance class System.Runtime.Serialization.SerializationBinder Binder" />
88       <MemberType>Property</MemberType>
89       <AssemblyInfo>
90         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
91         <AssemblyVersion>2.0.0.0</AssemblyVersion>
92         <AssemblyVersion>4.0.0.0</AssemblyVersion>
93       </AssemblyInfo>
94       <ReturnValue>
95         <ReturnType>System.Runtime.Serialization.SerializationBinder</ReturnType>
96       </ReturnValue>
97       <Docs>
98         <summary>To be added.</summary>
99         <value>To be added.</value>
100         <remarks>To be added.</remarks>
101       </Docs>
102     </Member>
103     <Member MemberName="Context">
104       <MemberSignature Language="C#" Value="public System.Runtime.Serialization.StreamingContext Context { get; set; }" />
105       <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Runtime.Serialization.StreamingContext Context" />
106       <MemberType>Property</MemberType>
107       <AssemblyInfo>
108         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
109         <AssemblyVersion>2.0.0.0</AssemblyVersion>
110         <AssemblyVersion>4.0.0.0</AssemblyVersion>
111       </AssemblyInfo>
112       <ReturnValue>
113         <ReturnType>System.Runtime.Serialization.StreamingContext</ReturnType>
114       </ReturnValue>
115       <Docs>
116         <summary>To be added.</summary>
117         <value>To be added.</value>
118         <remarks>To be added.</remarks>
119       </Docs>
120     </Member>
121     <Member MemberName="Deserialize">
122       <MemberSignature Language="C#" Value="public object Deserialize (System.IO.Stream serializationStream);" />
123       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance object Deserialize(class System.IO.Stream serializationStream) cil managed" />
124       <MemberType>Method</MemberType>
125       <AssemblyInfo>
126         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
127         <AssemblyVersion>2.0.0.0</AssemblyVersion>
128         <AssemblyVersion>4.0.0.0</AssemblyVersion>
129       </AssemblyInfo>
130       <ReturnValue>
131         <ReturnType>System.Object</ReturnType>
132       </ReturnValue>
133       <Parameters>
134         <Parameter Name="serializationStream" Type="System.IO.Stream" />
135       </Parameters>
136       <Docs>
137         <param name="serializationStream">To be added: an object of type 'IO.Stream'</param>
138         <summary>To be added</summary>
139         <returns>To be added: an object of type 'object'</returns>
140         <remarks>To be added</remarks>
141       </Docs>
142     </Member>
143     <Member MemberName="Deserialize">
144       <MemberSignature Language="C#" Value="public object Deserialize (System.IO.Stream serializationStream, System.Runtime.Remoting.Messaging.HeaderHandler handler);" />
145       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance object Deserialize(class System.IO.Stream serializationStream, class System.Runtime.Remoting.Messaging.HeaderHandler handler) cil managed" />
146       <MemberType>Method</MemberType>
147       <AssemblyInfo>
148         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
149         <AssemblyVersion>2.0.0.0</AssemblyVersion>
150         <AssemblyVersion>4.0.0.0</AssemblyVersion>
151       </AssemblyInfo>
152       <ReturnValue>
153         <ReturnType>System.Object</ReturnType>
154       </ReturnValue>
155       <Parameters>
156         <Parameter Name="serializationStream" Type="System.IO.Stream" />
157         <Parameter Name="handler" Type="System.Runtime.Remoting.Messaging.HeaderHandler" />
158       </Parameters>
159       <Docs>
160         <param name="serializationStream">To be added: an object of type 'IO.Stream'</param>
161         <param name="handler">To be added: an object of type 'Runtime.Remoting.Messaging.HeaderHandler'</param>
162         <summary>To be added</summary>
163         <returns>To be added: an object of type 'object'</returns>
164         <remarks>To be added</remarks>
165       </Docs>
166     </Member>
167     <Member MemberName="DeserializeMethodResponse">
168       <MemberSignature Language="C#" Value="public object DeserializeMethodResponse (System.IO.Stream serializationStream, System.Runtime.Remoting.Messaging.HeaderHandler handler, System.Runtime.Remoting.Messaging.IMethodCallMessage methodCallMessage);" />
169       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance object DeserializeMethodResponse(class System.IO.Stream serializationStream, class System.Runtime.Remoting.Messaging.HeaderHandler handler, class System.Runtime.Remoting.Messaging.IMethodCallMessage methodCallMessage) cil managed" />
170       <MemberType>Method</MemberType>
171       <AssemblyInfo>
172         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
173         <AssemblyVersion>2.0.0.0</AssemblyVersion>
174         <AssemblyVersion>4.0.0.0</AssemblyVersion>
175       </AssemblyInfo>
176       <ReturnValue>
177         <ReturnType>System.Object</ReturnType>
178       </ReturnValue>
179       <Parameters>
180         <Parameter Name="serializationStream" Type="System.IO.Stream" />
181         <Parameter Name="handler" Type="System.Runtime.Remoting.Messaging.HeaderHandler" />
182         <Parameter Name="methodCallMessage" Type="System.Runtime.Remoting.Messaging.IMethodCallMessage" />
183       </Parameters>
184       <Docs>
185         <param name="serializationStream">To be added: an object of type 'IO.Stream'</param>
186         <param name="handler">To be added: an object of type 'Runtime.Remoting.Messaging.HeaderHandler'</param>
187         <param name="methodCallMessage">To be added.</param>
188         <summary>To be added</summary>
189         <returns>To be added: an object of type 'object'</returns>
190         <remarks>To be added</remarks>
191       </Docs>
192     </Member>
193     <Member MemberName="FilterLevel">
194       <MemberSignature Language="C#" Value="public System.Runtime.Serialization.Formatters.TypeFilterLevel FilterLevel { get; set; }" />
195       <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Runtime.Serialization.Formatters.TypeFilterLevel FilterLevel" />
196       <MemberType>Property</MemberType>
197       <AssemblyInfo>
198         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
199         <AssemblyVersion>2.0.0.0</AssemblyVersion>
200         <AssemblyVersion>4.0.0.0</AssemblyVersion>
201       </AssemblyInfo>
202       <ReturnValue>
203         <ReturnType>System.Runtime.Serialization.Formatters.TypeFilterLevel</ReturnType>
204       </ReturnValue>
205       <Docs>
206         <summary>To be added.</summary>
207         <value>To be added.</value>
208         <remarks>To be added.</remarks>
209       </Docs>
210     </Member>
211     <Member MemberName="Serialize">
212       <MemberSignature Language="C#" Value="public void Serialize (System.IO.Stream serializationStream, object graph);" />
213       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Serialize(class System.IO.Stream serializationStream, object graph) cil managed" />
214       <MemberType>Method</MemberType>
215       <AssemblyInfo>
216         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
217         <AssemblyVersion>2.0.0.0</AssemblyVersion>
218         <AssemblyVersion>4.0.0.0</AssemblyVersion>
219       </AssemblyInfo>
220       <ReturnValue>
221         <ReturnType>System.Void</ReturnType>
222       </ReturnValue>
223       <Parameters>
224         <Parameter Name="serializationStream" Type="System.IO.Stream" />
225         <Parameter Name="graph" Type="System.Object" />
226       </Parameters>
227       <Docs>
228         <param name="serializationStream">To be added: an object of type 'IO.Stream'</param>
229         <param name="graph">To be added: an object of type 'object'</param>
230         <summary>To be added</summary>
231         <remarks>To be added</remarks>
232       </Docs>
233     </Member>
234     <Member MemberName="Serialize">
235       <MemberSignature Language="C#" Value="public void Serialize (System.IO.Stream serializationStream, object graph, System.Runtime.Remoting.Messaging.Header[] headers);" />
236       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Serialize(class System.IO.Stream serializationStream, object graph, class System.Runtime.Remoting.Messaging.Header[] headers) cil managed" />
237       <MemberType>Method</MemberType>
238       <AssemblyInfo>
239         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
240         <AssemblyVersion>2.0.0.0</AssemblyVersion>
241         <AssemblyVersion>4.0.0.0</AssemblyVersion>
242       </AssemblyInfo>
243       <ReturnValue>
244         <ReturnType>System.Void</ReturnType>
245       </ReturnValue>
246       <Parameters>
247         <Parameter Name="serializationStream" Type="System.IO.Stream" />
248         <Parameter Name="graph" Type="System.Object" />
249         <Parameter Name="headers" Type="System.Runtime.Remoting.Messaging.Header[]" />
250       </Parameters>
251       <Docs>
252         <param name="serializationStream">To be added: an object of type 'IO.Stream'</param>
253         <param name="graph">To be added: an object of type 'object'</param>
254         <param name="headers">To be added: an object of type 'Runtime.Remoting.Messaging.Header []'</param>
255         <summary>To be added</summary>
256         <remarks>To be added</remarks>
257       </Docs>
258     </Member>
259     <Member MemberName="SurrogateSelector">
260       <MemberSignature Language="C#" Value="public System.Runtime.Serialization.ISurrogateSelector SurrogateSelector { get; set; }" />
261       <MemberSignature Language="ILAsm" Value=".property instance class System.Runtime.Serialization.ISurrogateSelector SurrogateSelector" />
262       <MemberType>Property</MemberType>
263       <AssemblyInfo>
264         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
265         <AssemblyVersion>2.0.0.0</AssemblyVersion>
266         <AssemblyVersion>4.0.0.0</AssemblyVersion>
267       </AssemblyInfo>
268       <ReturnValue>
269         <ReturnType>System.Runtime.Serialization.ISurrogateSelector</ReturnType>
270       </ReturnValue>
271       <Docs>
272         <summary>To be added.</summary>
273         <value>To be added.</value>
274         <remarks>To be added.</remarks>
275       </Docs>
276     </Member>
277     <Member MemberName="TypeFormat">
278       <MemberSignature Language="C#" Value="public System.Runtime.Serialization.Formatters.FormatterTypeStyle TypeFormat { get; set; }" />
279       <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Runtime.Serialization.Formatters.FormatterTypeStyle TypeFormat" />
280       <MemberType>Property</MemberType>
281       <AssemblyInfo>
282         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
283         <AssemblyVersion>2.0.0.0</AssemblyVersion>
284         <AssemblyVersion>4.0.0.0</AssemblyVersion>
285       </AssemblyInfo>
286       <ReturnValue>
287         <ReturnType>System.Runtime.Serialization.Formatters.FormatterTypeStyle</ReturnType>
288       </ReturnValue>
289       <Docs>
290         <summary>To be added.</summary>
291         <value>To be added.</value>
292         <remarks>To be added.</remarks>
293       </Docs>
294     </Member>
295     <Member MemberName="UnsafeDeserialize">
296       <MemberSignature Language="C#" Value="public object UnsafeDeserialize (System.IO.Stream serializationStream, System.Runtime.Remoting.Messaging.HeaderHandler handler);" />
297       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance object UnsafeDeserialize(class System.IO.Stream serializationStream, class System.Runtime.Remoting.Messaging.HeaderHandler handler) cil managed" />
298       <MemberType>Method</MemberType>
299       <AssemblyInfo>
300         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
301         <AssemblyVersion>2.0.0.0</AssemblyVersion>
302         <AssemblyVersion>4.0.0.0</AssemblyVersion>
303       </AssemblyInfo>
304       <Attributes>
305         <Attribute>
306           <AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
307         </Attribute>
308       </Attributes>
309       <ReturnValue>
310         <ReturnType>System.Object</ReturnType>
311       </ReturnValue>
312       <Parameters>
313         <Parameter Name="serializationStream" Type="System.IO.Stream" />
314         <Parameter Name="handler" Type="System.Runtime.Remoting.Messaging.HeaderHandler" />
315       </Parameters>
316       <Docs>
317         <param name="serializationStream">To be added.</param>
318         <param name="handler">To be added.</param>
319         <summary>To be added.</summary>
320         <returns>To be added.</returns>
321         <remarks>To be added.</remarks>
322       </Docs>
323     </Member>
324     <Member MemberName="UnsafeDeserializeMethodResponse">
325       <MemberSignature Language="C#" Value="public object UnsafeDeserializeMethodResponse (System.IO.Stream serializationStream, System.Runtime.Remoting.Messaging.HeaderHandler handler, System.Runtime.Remoting.Messaging.IMethodCallMessage methodCallMessage);" />
326       <MemberSignature Language="ILAsm" Value=".method public hidebysig instance object UnsafeDeserializeMethodResponse(class System.IO.Stream serializationStream, class System.Runtime.Remoting.Messaging.HeaderHandler handler, class System.Runtime.Remoting.Messaging.IMethodCallMessage methodCallMessage) cil managed" />
327       <MemberType>Method</MemberType>
328       <AssemblyInfo>
329         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
330         <AssemblyVersion>2.0.0.0</AssemblyVersion>
331         <AssemblyVersion>4.0.0.0</AssemblyVersion>
332       </AssemblyInfo>
333       <Attributes>
334         <Attribute>
335           <AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
336         </Attribute>
337       </Attributes>
338       <ReturnValue>
339         <ReturnType>System.Object</ReturnType>
340       </ReturnValue>
341       <Parameters>
342         <Parameter Name="serializationStream" Type="System.IO.Stream" />
343         <Parameter Name="handler" Type="System.Runtime.Remoting.Messaging.HeaderHandler" />
344         <Parameter Name="methodCallMessage" Type="System.Runtime.Remoting.Messaging.IMethodCallMessage" />
345       </Parameters>
346       <Docs>
347         <param name="serializationStream">To be added.</param>
348         <param name="handler">To be added.</param>
349         <param name="methodCallMessage">To be added.</param>
350         <summary>To be added.</summary>
351         <returns>To be added.</returns>
352         <remarks>To be added.</remarks>
353       </Docs>
354     </Member>
355   </Members>
356 </Type>