1 <?xml version="1.0" encoding="utf-8"?>
2 <Type Name="DbParameterCollection" FullName="System.Data.Common.DbParameterCollection">
3 <TypeSignature Language="C#" Value="public abstract class DbParameterCollection : MarshalByRefObject, System.Data.IDataParameterCollection" />
5 <AssemblyName>System.Data</AssemblyName>
6 <AssemblyVersion>2.0.0.0</AssemblyVersion>
9 <BaseTypeName>System.MarshalByRefObject</BaseTypeName>
13 <InterfaceName>System.Data.IDataParameterCollection</InterfaceName>
17 <remarks>To be added.</remarks>
18 <since version=".NET 2.0" />
20 <attribution license="cc4" from="Microsoft" modified="false" />
21 <para>The base class for a collection of parameters relevant to a <see cref="T:System.Data.Common.DbCommand" />. </para>
25 <Member MemberName=".ctor">
26 <MemberSignature Language="C#" Value="protected DbParameterCollection ();" />
27 <MemberType>Constructor</MemberType>
30 <remarks>To be added.</remarks>
31 <since version=".NET 2.0" />
33 <attribution license="cc4" from="Microsoft" modified="false" />
34 <para>Initializes a new instance of the <see cref="T:System.Data.Common.DbParameterCollection" /> class.</para>
38 <AssemblyVersion>2.0.0.0</AssemblyVersion>
41 <Member MemberName="Add">
42 <MemberSignature Language="C#" Value="public abstract int Add (object value);" />
43 <MemberType>Method</MemberType>
45 <ReturnType>System.Int32</ReturnType>
48 <Parameter Name="value" Type="System.Object" />
51 <returns>To be added.</returns>
52 <remarks>To be added.</remarks>
53 <since version=".NET 2.0" />
55 <attribution license="cc4" from="Microsoft" modified="false" />
56 <para>Adds the specified <see cref="T:System.Data.Common.DbParameter" /> object to the <see cref="T:System.Data.Common.DbParameterCollection" />.</para>
59 <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="P:System.Data.Common.DbParameter.Value" /> of the <see cref="T:System.Data.Common.DbParameter" /> to add to the collection.</param>
62 <AssemblyVersion>2.0.0.0</AssemblyVersion>
65 <Member MemberName="AddRange">
66 <MemberSignature Language="C#" Value="public abstract void AddRange (Array values);" />
67 <MemberType>Method</MemberType>
69 <ReturnType>System.Void</ReturnType>
72 <Parameter Name="values" Type="System.Array" />
75 <remarks>To be added.</remarks>
76 <since version=".NET 2.0" />
78 <attribution license="cc4" from="Microsoft" modified="false" />
79 <para>Adds an array of items with the specified values to the <see cref="T:System.Data.Common.DbParameterCollection" />.</para>
82 <attribution license="cc4" from="Microsoft" modified="false" />An array of values of type <see cref="T:System.Data.Common.DbParameter" /> to add to the collection.</param>
85 <AssemblyVersion>2.0.0.0</AssemblyVersion>
88 <Member MemberName="Clear">
89 <MemberSignature Language="C#" Value="public abstract void Clear ();" />
90 <MemberType>Method</MemberType>
92 <ReturnType>System.Void</ReturnType>
96 <remarks>To be added.</remarks>
97 <since version=".NET 2.0" />
99 <attribution license="cc4" from="Microsoft" modified="false" />
100 <para>Removes all <see cref="T:System.Data.Common.DbParameter" /> values from the <see cref="T:System.Data.Common.DbParameterCollection" />.</para>
104 <AssemblyVersion>2.0.0.0</AssemblyVersion>
107 <Member MemberName="Contains">
108 <MemberSignature Language="C#" Value="public abstract bool Contains (object value);" />
109 <MemberType>Method</MemberType>
111 <ReturnType>System.Boolean</ReturnType>
114 <Parameter Name="value" Type="System.Object" />
117 <returns>To be added.</returns>
118 <remarks>To be added.</remarks>
119 <since version=".NET 2.0" />
121 <attribution license="cc4" from="Microsoft" modified="false" />
122 <para>Indicates whether a <see cref="T:System.Data.Common.DbParameter" /> with the specified <see cref="P:System.Data.Common.DbParameter.Value" /> is contained in the collection.</para>
125 <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="P:System.Data.Common.DbParameter.Value" /> of the <see cref="T:System.Data.Common.DbParameter" /> to look for in the collection.</param>
128 <AssemblyVersion>2.0.0.0</AssemblyVersion>
131 <Member MemberName="Contains">
132 <MemberSignature Language="C#" Value="public abstract bool Contains (string value);" />
133 <MemberType>Method</MemberType>
135 <ReturnType>System.Boolean</ReturnType>
138 <Parameter Name="value" Type="System.String" />
141 <returns>To be added.</returns>
142 <remarks>To be added.</remarks>
143 <since version=".NET 2.0" />
145 <attribution license="cc4" from="Microsoft" modified="false" />
146 <para>Indicates whether a <see cref="T:System.Data.Common.DbParameter" /> with the specified name exists in the collection.</para>
149 <attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Data.Common.DbParameter" /> to look for in the collection.</param>
152 <AssemblyVersion>2.0.0.0</AssemblyVersion>
155 <Member MemberName="CopyTo">
156 <MemberSignature Language="C#" Value="public abstract void CopyTo (Array array, int index);" />
157 <MemberType>Method</MemberType>
159 <ReturnType>System.Void</ReturnType>
162 <Parameter Name="array" Type="System.Array" />
163 <Parameter Name="index" Type="System.Int32" />
166 <remarks>To be added.</remarks>
167 <since version=".NET 2.0" />
169 <attribution license="cc4" from="Microsoft" modified="false" />
170 <para>Copies an array of items to the collection starting at the specified index.</para>
173 <attribution license="cc4" from="Microsoft" modified="false" />The array of items to copy to the collection.</param>
175 <attribution license="cc4" from="Microsoft" modified="false" />The index in the collection to copy the items.</param>
178 <AssemblyVersion>2.0.0.0</AssemblyVersion>
181 <Member MemberName="Count">
182 <MemberSignature Language="C#" Value="public abstract int Count { get; }" />
183 <MemberType>Property</MemberType>
186 <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
189 <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
193 <ReturnType>System.Int32</ReturnType>
196 <value>To be added.</value>
197 <remarks>To be added.</remarks>
198 <since version=".NET 2.0" />
200 <attribution license="cc4" from="Microsoft" modified="false" />
201 <para>Specifies the number of items in the collection.</para>
205 <AssemblyVersion>2.0.0.0</AssemblyVersion>
208 <Member MemberName="GetEnumerator">
209 <MemberSignature Language="C#" Value="public abstract System.Collections.IEnumerator GetEnumerator ();" />
210 <MemberType>Method</MemberType>
212 <ReturnType>System.Collections.IEnumerator</ReturnType>
216 <returns>To be added.</returns>
217 <remarks>To be added.</remarks>
218 <since version=".NET 2.0" />
220 <attribution license="cc4" from="Microsoft" modified="false" />
221 <para>Exposes the <see cref="M:System.Collections.IEnumerable.GetEnumerator" /> method, which supports a simple iteration over a collection by a .NET Framework data provider.</para>
225 <AssemblyVersion>2.0.0.0</AssemblyVersion>
229 <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
233 <Member MemberName="GetParameter">
234 <MemberSignature Language="C#" Value="protected abstract System.Data.Common.DbParameter GetParameter (int index);" />
235 <MemberType>Method</MemberType>
237 <ReturnType>System.Data.Common.DbParameter</ReturnType>
240 <Parameter Name="index" Type="System.Int32" />
243 <returns>To be added.</returns>
244 <remarks>To be added.</remarks>
245 <since version=".NET 2.0" />
247 <attribution license="cc4" from="Microsoft" modified="false" />
248 <para>Returns the <see cref="T:System.Data.Common.DbParameter" /> object at the specified index in the collection.</para>
251 <attribution license="cc4" from="Microsoft" modified="false" />The index of the <see cref="T:System.Data.Common.DbParameter" /> in the collection.</param>
254 <AssemblyVersion>2.0.0.0</AssemblyVersion>
257 <Member MemberName="GetParameter">
258 <MemberSignature Language="C#" Value="protected abstract System.Data.Common.DbParameter GetParameter (string parameterName);" />
259 <MemberType>Method</MemberType>
261 <ReturnType>System.Data.Common.DbParameter</ReturnType>
264 <Parameter Name="parameterName" Type="System.String" />
267 <returns>To be added.</returns>
268 <remarks>To be added.</remarks>
269 <since version=".NET 2.0" />
271 <attribution license="cc4" from="Microsoft" modified="false" />
272 <para>Returns <see cref="T:System.Data.Common.DbParameter" /> the object with the specified name.</para>
274 <param name="parameterName">
275 <attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Data.Common.DbParameter" /> in the collection.</param>
278 <AssemblyVersion>2.0.0.0</AssemblyVersion>
281 <Member MemberName="IndexOf">
282 <MemberSignature Language="C#" Value="public abstract int IndexOf (object value);" />
283 <MemberType>Method</MemberType>
285 <ReturnType>System.Int32</ReturnType>
288 <Parameter Name="value" Type="System.Object" />
291 <returns>To be added.</returns>
292 <remarks>To be added.</remarks>
293 <since version=".NET 2.0" />
295 <attribution license="cc4" from="Microsoft" modified="false" />
296 <para>Returns the index of the specified <see cref="T:System.Data.Common.DbParameter" /> object.</para>
299 <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.Common.DbParameter" /> object in the collection.</param>
302 <AssemblyVersion>2.0.0.0</AssemblyVersion>
305 <Member MemberName="IndexOf">
306 <MemberSignature Language="C#" Value="public abstract int IndexOf (string parameterName);" />
307 <MemberType>Method</MemberType>
309 <ReturnType>System.Int32</ReturnType>
312 <Parameter Name="parameterName" Type="System.String" />
315 <returns>To be added.</returns>
316 <remarks>To be added.</remarks>
317 <since version=".NET 2.0" />
319 <attribution license="cc4" from="Microsoft" modified="false" />
320 <para>Returns the index of the <see cref="T:System.Data.Common.DbParameter" /> object with the specified name.</para>
322 <param name="parameterName">
323 <attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Data.Common.DbParameter" /> object in the collection.</param>
326 <AssemblyVersion>2.0.0.0</AssemblyVersion>
329 <Member MemberName="Insert">
330 <MemberSignature Language="C#" Value="public abstract void Insert (int index, object value);" />
331 <MemberType>Method</MemberType>
333 <ReturnType>System.Void</ReturnType>
336 <Parameter Name="index" Type="System.Int32" />
337 <Parameter Name="value" Type="System.Object" />
340 <remarks>To be added.</remarks>
341 <since version=".NET 2.0" />
343 <attribution license="cc4" from="Microsoft" modified="false" />
344 <para>Inserts the specified index of the <see cref="T:System.Data.Common.DbParameter" /> object with the specified name into the collection at the specified index.</para>
347 <attribution license="cc4" from="Microsoft" modified="false" />The index at which to insert the <see cref="T:System.Data.Common.DbParameter" /> object.</param>
349 <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.Common.DbParameter" /> object to insert into the collection.</param>
352 <AssemblyVersion>2.0.0.0</AssemblyVersion>
355 <Member MemberName="IsFixedSize">
356 <MemberSignature Language="C#" Value="public abstract bool IsFixedSize { get; }" />
357 <MemberType>Property</MemberType>
360 <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
363 <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
366 <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
370 <ReturnType>System.Boolean</ReturnType>
373 <value>To be added.</value>
374 <remarks>To be added.</remarks>
375 <since version=".NET 2.0" />
377 <attribution license="cc4" from="Microsoft" modified="false" />
378 <para>Specifies whether the collection is a fixed size.</para>
382 <AssemblyVersion>2.0.0.0</AssemblyVersion>
385 <Member MemberName="IsReadOnly">
386 <MemberSignature Language="C#" Value="public abstract bool IsReadOnly { get; }" />
387 <MemberType>Property</MemberType>
390 <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
393 <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
396 <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
400 <ReturnType>System.Boolean</ReturnType>
403 <value>To be added.</value>
404 <remarks>To be added.</remarks>
405 <since version=".NET 2.0" />
407 <attribution license="cc4" from="Microsoft" modified="false" />
408 <para>Specifies whether the collection is read-only.</para>
412 <AssemblyVersion>2.0.0.0</AssemblyVersion>
415 <Member MemberName="IsSynchronized">
416 <MemberSignature Language="C#" Value="public abstract bool IsSynchronized { get; }" />
417 <MemberType>Property</MemberType>
420 <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
423 <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
426 <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
430 <ReturnType>System.Boolean</ReturnType>
433 <value>To be added.</value>
434 <remarks>To be added.</remarks>
435 <since version=".NET 2.0" />
437 <attribution license="cc4" from="Microsoft" modified="false" />
438 <para>Specifies whether the collection is synchronized.</para>
442 <AssemblyVersion>2.0.0.0</AssemblyVersion>
445 <Member MemberName="Item">
446 <MemberSignature Language="C#" Value="public System.Data.Common.DbParameter this[int index] { set; get; }" />
447 <MemberType>Property</MemberType>
449 <ReturnType>System.Data.Common.DbParameter</ReturnType>
452 <Parameter Name="index" Type="System.Int32" />
455 <param name="index">To be added.</param>
456 <summary>To be added.</summary>
457 <value>To be added.</value>
458 <remarks>To be added.</remarks>
459 <since version=".NET 2.0" />
462 <AssemblyVersion>2.0.0.0</AssemblyVersion>
465 <Member MemberName="Item">
466 <MemberSignature Language="C#" Value="public System.Data.Common.DbParameter this[string parameterName] { set; get; }" />
467 <MemberType>Property</MemberType>
469 <ReturnType>System.Data.Common.DbParameter</ReturnType>
472 <Parameter Name="parameterName" Type="System.String" />
475 <param name="parameterName">To be added.</param>
476 <summary>To be added.</summary>
477 <value>To be added.</value>
478 <remarks>To be added.</remarks>
479 <since version=".NET 2.0" />
482 <AssemblyVersion>2.0.0.0</AssemblyVersion>
485 <Member MemberName="Remove">
486 <MemberSignature Language="C#" Value="public abstract void Remove (object value);" />
487 <MemberType>Method</MemberType>
489 <ReturnType>System.Void</ReturnType>
492 <Parameter Name="value" Type="System.Object" />
495 <remarks>To be added.</remarks>
496 <since version=".NET 2.0" />
498 <attribution license="cc4" from="Microsoft" modified="false" />
499 <para>Removes the specified <see cref="T:System.Data.Common.DbParameter" /> object from the collection.</para>
502 <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.Common.DbParameter" /> object to remove.</param>
505 <AssemblyVersion>2.0.0.0</AssemblyVersion>
508 <Member MemberName="RemoveAt">
509 <MemberSignature Language="C#" Value="public abstract void RemoveAt (int index);" />
510 <MemberType>Method</MemberType>
512 <ReturnType>System.Void</ReturnType>
515 <Parameter Name="index" Type="System.Int32" />
518 <remarks>To be added.</remarks>
519 <since version=".NET 2.0" />
521 <attribution license="cc4" from="Microsoft" modified="false" />
522 <para>Removes the <see cref="T:System.Data.Common.DbParameter" /> object at the specified from the collection.</para>
525 <attribution license="cc4" from="Microsoft" modified="false" />The index where the <see cref="T:System.Data.Common.DbParameter" /> object is located.</param>
528 <AssemblyVersion>2.0.0.0</AssemblyVersion>
531 <Member MemberName="RemoveAt">
532 <MemberSignature Language="C#" Value="public abstract void RemoveAt (string parameterName);" />
533 <MemberType>Method</MemberType>
535 <ReturnType>System.Void</ReturnType>
538 <Parameter Name="parameterName" Type="System.String" />
541 <remarks>To be added.</remarks>
542 <since version=".NET 2.0" />
544 <attribution license="cc4" from="Microsoft" modified="false" />
545 <para>Removes the <see cref="T:System.Data.Common.DbParameter" /> object with the specified name from the collection.</para>
547 <param name="parameterName">
548 <attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Data.Common.DbParameter" /> object to remove.</param>
551 <AssemblyVersion>2.0.0.0</AssemblyVersion>
554 <Member MemberName="SetParameter">
555 <MemberSignature Language="C#" Value="protected abstract void SetParameter (int index, System.Data.Common.DbParameter value);" />
556 <MemberType>Method</MemberType>
558 <ReturnType>System.Void</ReturnType>
561 <Parameter Name="index" Type="System.Int32" />
562 <Parameter Name="value" Type="System.Data.Common.DbParameter" />
565 <remarks>To be added.</remarks>
566 <since version=".NET 2.0" />
568 <attribution license="cc4" from="Microsoft" modified="false" />
569 <para>Sets the <see cref="T:System.Data.Common.DbParameter" /> object at the specified index to a new value. </para>
572 <attribution license="cc4" from="Microsoft" modified="false" />The index where the <see cref="T:System.Data.Common.DbParameter" /> object is located.</param>
574 <attribution license="cc4" from="Microsoft" modified="false" />The new <see cref="T:System.Data.Common.DbParameter" /> value.</param>
577 <AssemblyVersion>2.0.0.0</AssemblyVersion>
580 <Member MemberName="SetParameter">
581 <MemberSignature Language="C#" Value="protected abstract void SetParameter (string parameterName, System.Data.Common.DbParameter value);" />
582 <MemberType>Method</MemberType>
584 <ReturnType>System.Void</ReturnType>
587 <Parameter Name="parameterName" Type="System.String" />
588 <Parameter Name="value" Type="System.Data.Common.DbParameter" />
591 <remarks>To be added.</remarks>
592 <since version=".NET 2.0" />
594 <attribution license="cc4" from="Microsoft" modified="false" />
595 <para>Sets the <see cref="T:System.Data.Common.DbParameter" /> object with the specified name to a new value.</para>
597 <param name="parameterName">
598 <attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Data.Common.DbParameter" /> object in the collection.</param>
600 <attribution license="cc4" from="Microsoft" modified="false" />The new <see cref="T:System.Data.Common.DbParameter" /> value.</param>
603 <AssemblyVersion>2.0.0.0</AssemblyVersion>
606 <Member MemberName="SyncRoot">
607 <MemberSignature Language="C#" Value="public abstract object SyncRoot { get; }" />
608 <MemberType>Property</MemberType>
611 <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
614 <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
617 <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
621 <ReturnType>System.Object</ReturnType>
624 <value>To be added.</value>
625 <remarks>To be added.</remarks>
626 <since version=".NET 2.0" />
628 <attribution license="cc4" from="Microsoft" modified="false" />
629 <para>Specifies the <see cref="T:System.Object" /> to be used to synchronize access to the collection.</para>
633 <AssemblyVersion>2.0.0.0</AssemblyVersion>
636 <Member MemberName="System.Collections.IList.Item">
637 <MemberSignature Language="C#" Value="object System.Collections.IList.Item[int index] { set; get; }" />
638 <MemberType>Property</MemberType>
640 <AssemblyVersion>2.0.0.0</AssemblyVersion>
643 <ReturnType>System.Object</ReturnType>
646 <Parameter Name="index" Type="System.Int32" />
649 <param name="index">To be added.</param>
650 <summary>To be added.</summary>
651 <value>To be added.</value>
652 <remarks>To be added.</remarks>
655 <Member MemberName="System.Data.IDataParameterCollection.Item">
656 <MemberSignature Language="C#" Value="object System.Data.IDataParameterCollection.Item[string parameterName] { set; get; }" />
657 <MemberType>Property</MemberType>
659 <AssemblyVersion>2.0.0.0</AssemblyVersion>
662 <ReturnType>System.Object</ReturnType>
665 <Parameter Name="parameterName" Type="System.String" />
668 <param name="parameterName">To be added.</param>
669 <summary>To be added.</summary>
670 <value>To be added.</value>
671 <remarks>To be added.</remarks>