File: ArgumentException.xml

package info (click to toggle)
monodoc 1.9-2
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 98,436 kB
  • ctags: 5,261
  • sloc: xml: 1,506,218; cs: 40,827; sh: 3,647; perl: 554; makefile: 476
file content (343 lines) | stat: -rwxr-xr-x 17,237 bytes parent folder | download | duplicates (3)
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
<Type Name="ArgumentException" FullName="System.ArgumentException" FullNameSP="System_ArgumentException" Maintainer="ecma">
  <TypeSignature Language="ILASM" Value=".class public serializable ArgumentException extends System.SystemException" />
  <TypeSignature Language="C#" Value="public class ArgumentException : SystemException" />
  <MemberOfLibrary>BCL</MemberOfLibrary>
  <AssemblyInfo>
    <AssemblyName>mscorlib</AssemblyName>
    <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
  <Base>
    <BaseTypeName>System.SystemException</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
      <para> Represents the error that
      occurs when an argument passed to a method is invalid.</para>
    </summary>
    <remarks>
      <para>
        <see cref="T:System.ArgumentException" /> is thrown when a method is invoked and at
   least one of the passed arguments does not meet the method's parameter specification.</para>
      <block subset="none" type="note">
        <para>The Base Class Library includes three derived types: </para>
        <list type="bullet">
          <item>
            <term>
              <see cref="T:System.ArgumentNullException" />
            </term>
          </item>
          <item>
            <term>
              <para>
                <see cref="T:System.ArgumentOutOfRangeException" />
              </para>
            </term>
          </item>
          <item>
            <term>
              <para>
                <see cref="T:System.DuplicateWaitObjectException" />
              </para>
            </term>
          </item>
        </list>
        <para>When appropriate, use these types instead of <see cref="T:System.ArgumentException" />.</para>
      </block>
    </remarks>
    <example>
      <para>The following example demonstrates an error that causes
      a <see cref="T:System.ArgumentException" /> exception to be thrown by the system.</para>
      <code lang="C#">using System;
public class MyClass {}
public class ArgExceptionExample {
  public static void Main() {
    MyClass my = new MyClass();
    string s = "sometext";
    try {
       int i = s.CompareTo(my);
    }
    catch (ArgumentException e) {
       Console.WriteLine("Error: {0}",e);
    }
  }
}
   </code>
      <para>The output is</para>
      <c>
        <para>Error: System.ArgumentException: Object must be of type String.</para>
        <para>at System.String.CompareTo(Object value)</para>
        <para>at ArgExceptionExample.Main()</para>
      </c>
    </example>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor()" />
      <MemberSignature Language="C#" Value="public ArgumentException ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>
          <para>Constructs and initializes a new instance of the <see cref="T:System.ArgumentException" />
class.</para>
        </summary>
        <remarks>
          <para>This constructor initializes the <see cref="P:System.ArgumentException.Message" /> property of the new instance to a system-supplied
   message that describes the error, such as "An invalid argument was specified."
   This message takes into account the current system culture.</para>
          <para>The <see cref="!:System.ArgumentException.InnerException" /> property is initialized to 
<see langword="null" /> .</para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(string message)" />
      <MemberSignature Language="C#" Value="public ArgumentException (string message);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="message" Type="System.String" />
      </Parameters>
      <Docs>
        <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>
        <summary>
          <para>Constructs and initializes a new instance of the <see cref="T:System.ArgumentException" /> class.</para>
        </summary>
        <remarks>
          <para>This constructor initializes the <see cref="P:System.ArgumentException.Message" /> property of the new instance using <paramref name="message" />. If <paramref name="message" /> is
<see langword="null" />, the <see cref="P:System.ArgumentException.Message" /> property is initialized to the 
   system-supplied message provided by the constructor that takes no arguments. The <see cref="!:System.ArgumentException.InnerException" /> and
<see cref="P:System.ArgumentException.ParamName" /> properties are
   initialized to <see langword="null" />.</para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected ArgumentException (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
        <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
      </Parameters>
      <Docs>
        <param name="info">To be added.</param>
        <param name="context">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(string message, class System.Exception innerException)" />
      <MemberSignature Language="C#" Value="public ArgumentException (string message, Exception innerException);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="innerException" Type="System.Exception" />
      </Parameters>
      <Docs>
        <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>
        <param name="innerException">An instance of <see cref="T:System.Exception" /> that is the cause of the current Exception. If <paramref name="innerException" /> is non-null, then the current Exception was raised in a catch block handling <paramref name="innerException" /> .</param>
        <summary>
          <para>Constructs and initializes a new instance of the <see cref="T:System.ArgumentException" />
class.</para>
        </summary>
        <remarks>
          <para>This constructor initializes the <see cref="P:System.ArgumentException.Message" /> property of the new instance using <paramref name="message" />, and the <see cref="!:System.ArgumentException.InnerException" />
property using <paramref name="innerException" />. If <paramref name="message" /> is
<see langword="null" />, the <see cref="P:System.ArgumentException.Message" /> property is initialized to the 
system-supplied message provided by the constructor that takes no arguments. The
<see cref="P:System.ArgumentException.ParamName" /> property is initialized to 
<see langword="null" /> 
. </para>
          <para>
            <block subset="none" type="note">For information on inner exceptions, see
<see cref="P:System.Exception.InnerException" />.</block>
          </para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(string message, string paramName)" />
      <MemberSignature Language="C#" Value="public ArgumentException (string message, string paramName);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="paramName" Type="System.String" />
      </Parameters>
      <Docs>
        <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>
        <param name="paramName">A <see cref="T:System.String" /> that contains the name of the parameter that caused the exception.</param>
        <summary>
          <para>Constructs and initializes a new instance of the <see cref="T:System.ArgumentException" />
class.</para>
        </summary>
        <remarks>
          <para>This constructor initializes the <see cref="P:System.ArgumentException.Message" /> property of the new instance using <paramref name="message" />, and
   the <see cref="P:System.ArgumentException.ParamName" /> property using <paramref name="paramName" />. If <paramref name="message" /> is <see langword="null" />,
   the <see cref="P:System.ArgumentException.Message" /> property is initialized to the system-supplied message
   provided by the constructor that takes no arguments. The <see cref="!:System.ArgumentException.InnerException" /> property is
   initialized to <see langword="null" />.</para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(string message, string paramName, class System.Exception innerException)" />
      <MemberSignature Language="C#" Value="public ArgumentException (string message, string paramName, Exception innerException);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="paramName" Type="System.String" />
        <Parameter Name="innerException" Type="System.Exception" />
      </Parameters>
      <Docs>
        <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>
        <param name="paramName">A <see cref="T:System.String" /> that contains the name of the parameter that caused the current exception.</param>
        <param name="innerException">An instance of <see cref="T:System.Exception" /> that is the cause of the current Exception. If <paramref name="innerException" /> is non-null, then the current Exception was raised in a catch block handling <paramref name="innerException" />.</param>
        <summary>
          <para>Constructs and initializes a new instance of the <see cref="T:System.ArgumentException" />
class.</para>
        </summary>
        <remarks>
          <para>This constructor initializes the <see cref="P:System.ArgumentException.Message" /> property of the new instance using <paramref name="message" />,
   the <see cref="P:System.ArgumentException.ParamName" /> property using <paramref name="paramName" />, and the <see cref="!:System.ArgumentException.InnerException" /> property using <paramref name="innerException" />. If <paramref name="message" /> is
<see langword="null" />, the <see cref="P:System.ArgumentException.Message" /> property is initialized to the 
   system-supplied message provided by the constructor that takes no arguments. </para>
          <para>
            <block subset="none" type="note"> For information on inner exceptions, see <see cref="P:System.Exception.InnerException" />.</block>
          </para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="GetObjectData">
      <MemberSignature Language="C#" Value="public override void GetObjectData (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
        <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
      </Parameters>
      <Docs>
        <param name="info">To be added.</param>
        <param name="context">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Message">
      <MemberSignature Language="C#" Value="public override string Message { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
          <para>Gets the error message that explains the reason for the exception.</para>
        </summary>
        <value>
          <para>A <see cref="T:System.String" /> containing the error message with <see cref="P:System.ArgumentException.ParamName" /> appended, if it in not <see langword="null" />.</para>
        </value>
        <remarks>
          <para> 
This property is read-only.</para>
        </remarks>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="ParamName">
      <MemberSignature Language="ILASM" Value=".property string ParamName { public hidebysig virtual specialname string get_ParamName() }" />
      <MemberSignature Language="C#" Value="public virtual string ParamName { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para> Gets the name of the parameter that caused the
      current Exception.</para>
        </summary>
        <value>
          <para> A <see cref="T:System.String" /> that contains the 
   name of the parameter that caused the current Exception, or
<see langword="null" /> if no value was specified to the constructor
   for
   the current instance.</para>
        </value>
        <remarks>
          <para> This property is read-only.</para>
          <para>
            <block subset="none" type="behaviors">The <see cref="P:System.ArgumentException.ParamName" /> property
   returns the same value as was passed into the constructor.</block>
          </para>
          <para>
            <block subset="none" type="overrides">Override
   the <see cref="P:System.ArgumentException.ParamName" /> property
   to customize the content or format of the parameter name. </block>
          </para>
          <para>
            <block subset="none" type="usage">
   Use this property to retrieve the name of the invalid parameter.
</block>
          </para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
  <TypeExcluded>0</TypeExcluded>
  <Attributes>
    <Attribute>
      <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
    </Attribute>
  </Attributes>
</Type>