docupdate: updated System.dll documentation
[mono.git] / mcs / class / System / Documentation / en / System.Net / ProtocolViolationException.xml
1 <Type Name="ProtocolViolationException" FullName="System.Net.ProtocolViolationException" FullNameSP="System_Net_ProtocolViolationException" Maintainer="ecma">
2   <TypeSignature Language="ILASM" Value=".class public serializable ProtocolViolationException extends System.InvalidOperationException" />
3   <TypeSignature Language="C#" Value="public class ProtocolViolationException : InvalidOperationException" />
4   <TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit ProtocolViolationException extends System.InvalidOperationException implements class System.Runtime.Serialization.ISerializable" />
5   <MemberOfLibrary>Networking</MemberOfLibrary>
6   <AssemblyInfo>
7     <AssemblyName>System</AssemblyName>
8     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
9     <AssemblyVersion>1.0.x.x</AssemblyVersion>
10     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
11     <AssemblyVersion>2.0.0.0</AssemblyVersion>
12     <AssemblyVersion>4.0.0.0</AssemblyVersion>
13   </AssemblyInfo>
14   <ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
15   <Base>
16     <BaseTypeName>System.InvalidOperationException</BaseTypeName>
17   </Base>
18   <Interfaces />
19   <Docs>
20     <summary>
21       <para> Represents errors that occur due to violating the rules of a network
22  protocol.</para>
23     </summary>
24     <remarks>
25       <para>A <see cref="T:System.Net.ProtocolViolationException" /> is thrown by types
26  derived from <see cref="T:System.Net.WebRequest" /> and <see cref="T:System.Net.WebResponse" /> to indicate that an error has occurred as defined by the rules of the underlying
27  protocol. For example, the <see cref="T:System.Net.HttpWebRequest" /> type throws a
28 <see cref="T:System.Net.ProtocolViolationException" /> when an application 
29  attempts to send content without specifying the content length.</para>
30     </remarks>
31   </Docs>
32   <Members>
33     <Member MemberName=".ctor">
34       <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor()" />
35       <MemberSignature Language="C#" Value="public ProtocolViolationException ();" />
36       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
37       <MemberType>Constructor</MemberType>
38       <AssemblyInfo>
39         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
40         <AssemblyVersion>2.0.0.0</AssemblyVersion>
41         <AssemblyVersion>4.0.0.0</AssemblyVersion>
42       </AssemblyInfo>
43       <ReturnValue />
44       <Parameters />
45       <Docs>
46         <summary>
47           <para> Constructs and initializes a new instance of the <see cref="T:System.Net.ProtocolViolationException" /> class.</para>
48         </summary>
49         <remarks>
50           <para>This constructor initializes the <see cref="!:System.Net.ProtocolViolationException.Message" /> property of the
51    new instance to a system-supplied message that describes the error, such as
52    "Protocol error occurred." This message takes into account the current system
53    culture.</para>
54           <para>The <see cref="!:System.Net.ProtocolViolationException.InnerException" /> property of the new instance is
55 initialized to <see langword="null" />.</para>
56         </remarks>
57       </Docs>
58       <Excluded>0</Excluded>
59     </Member>
60     <Member MemberName=".ctor">
61       <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(string message)" />
62       <MemberSignature Language="C#" Value="public ProtocolViolationException (string message);" />
63       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string message) cil managed" />
64       <MemberType>Constructor</MemberType>
65       <AssemblyInfo>
66         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
67         <AssemblyVersion>2.0.0.0</AssemblyVersion>
68         <AssemblyVersion>4.0.0.0</AssemblyVersion>
69       </AssemblyInfo>
70       <ReturnValue />
71       <Parameters>
72         <Parameter Name="message" Type="System.String" />
73       </Parameters>
74       <Docs>
75         <param name="message">A <see cref="T:System.String" /> that describes the error. The content of <paramref name="message" /> is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.</param>
76         <summary>
77           <para>Constructs and initializes a new instance of the <see cref="T:System.Net.ProtocolViolationException" />
78 class.</para>
79         </summary>
80         <remarks>
81           <para>This constructor initializes the <see cref="!:System.Net.ProtocolViolationException.Message" /> property
82    of the new instance using <paramref name="message" />. If <paramref name="message" /> is
83 <see langword="null" />, the <see cref="!:System.Net.ProtocolViolationException.Message" /> property is initialized to the system-supplied 
84    message provided by the constructor that takes no arguments. </para>
85           <para> The <see cref="!:System.Net.ProtocolViolationException.InnerException" /> property of the new
86 instance is initialized to <see langword="null" />. </para>
87         </remarks>
88       </Docs>
89       <Excluded>0</Excluded>
90     </Member>
91     <Member MemberName=".ctor">
92       <MemberSignature Language="C#" Value="protected ProtocolViolationException (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext);" />
93       <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.Runtime.Serialization.SerializationInfo serializationInfo, valuetype System.Runtime.Serialization.StreamingContext streamingContext) cil managed" />
94       <MemberType>Constructor</MemberType>
95       <AssemblyInfo>
96         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
97         <AssemblyVersion>2.0.0.0</AssemblyVersion>
98         <AssemblyVersion>4.0.0.0</AssemblyVersion>
99       </AssemblyInfo>
100       <Parameters>
101         <Parameter Name="serializationInfo" Type="System.Runtime.Serialization.SerializationInfo" />
102         <Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" />
103       </Parameters>
104       <Docs>
105         <param name="serializationInfo">To be added.</param>
106         <param name="streamingContext">To be added.</param>
107         <summary>To be added.</summary>
108         <remarks>To be added.</remarks>
109       </Docs>
110     </Member>
111     <Member MemberName="GetObjectData">
112       <MemberSignature Language="C#" Value="public override void GetObjectData (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext);" />
113       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void GetObjectData(class System.Runtime.Serialization.SerializationInfo serializationInfo, valuetype System.Runtime.Serialization.StreamingContext streamingContext) cil managed" />
114       <MemberType>Method</MemberType>
115       <AssemblyInfo>
116         <AssemblyVersion>2.0.0.0</AssemblyVersion>
117         <AssemblyVersion>4.0.0.0</AssemblyVersion>
118       </AssemblyInfo>
119       <ReturnValue>
120         <ReturnType>System.Void</ReturnType>
121       </ReturnValue>
122       <Parameters>
123         <Parameter Name="serializationInfo" Type="System.Runtime.Serialization.SerializationInfo" />
124         <Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" />
125       </Parameters>
126       <Docs>
127         <param name="serializationInfo">To be added.</param>
128         <param name="streamingContext">To be added.</param>
129         <summary>To be added.</summary>
130         <remarks>To be added.</remarks>
131       </Docs>
132     </Member>
133     <Member MemberName="System.Runtime.Serialization.ISerializable.GetObjectData">
134       <MemberSignature Language="C#" Value="void ISerializable.GetObjectData (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
135       <MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void System.Runtime.Serialization.ISerializable.GetObjectData(class System.Runtime.Serialization.SerializationInfo info, valuetype System.Runtime.Serialization.StreamingContext context) cil managed" />
136       <MemberType>Method</MemberType>
137       <AssemblyInfo>
138         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
139         <AssemblyVersion>2.0.0.0</AssemblyVersion>
140         <AssemblyVersion>4.0.0.0</AssemblyVersion>
141       </AssemblyInfo>
142       <ReturnValue>
143         <ReturnType>System.Void</ReturnType>
144       </ReturnValue>
145       <Parameters>
146         <Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
147         <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
148       </Parameters>
149       <Docs>
150         <param name="info">To be added.</param>
151         <param name="context">To be added.</param>
152         <summary>To be added.</summary>
153         <remarks>To be added.</remarks>
154       </Docs>
155     </Member>
156   </Members>
157   <TypeExcluded>0</TypeExcluded>
158 </Type>