DbDataAdapter.xml 191 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <Type Name="DbDataAdapter" FullName="System.Data.Common.DbDataAdapter">
  3. <TypeSignature Language="C#" Maintainer="auto" Value="public abstract class DbDataAdapter : System.Data.Common.DataAdapter, ICloneable, System.Data.IDbDataAdapter" />
  4. <AssemblyInfo>
  5. <AssemblyName>System.Data</AssemblyName>
  6. <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
  7. <AssemblyVersion>1.0.3300.0</AssemblyVersion>
  8. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  9. <AssemblyVersion>2.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.Data.Common.DataAdapter</BaseTypeName>
  14. </Base>
  15. <Interfaces>
  16. <Interface>
  17. <InterfaceName>System.Data.IDbDataAdapter</InterfaceName>
  18. </Interface>
  19. <Interface>
  20. <InterfaceName>System.ICloneable</InterfaceName>
  21. </Interface>
  22. </Interfaces>
  23. <Docs>
  24. <remarks>
  25. <attribution license="cc4" from="Microsoft" modified="false" />
  26. <para>The <see cref="T:System.Data.Common.DbDataAdapter" /> class inherits from the <see cref="T:System.Data.Common.DataAdapter" /> class and helps a class implement a DataAdapter designed for use with a relational database.</para>
  27. <para>An application does not create an instance of the <see cref="T:System.Data.Common.DbDataAdapter" /> interface directly, but creates an instance of a class that inherits <see cref="T:System.Data.IDbDataAdapter" /> and <see cref="T:System.Data.Common.DbDataAdapter" />.</para>
  28. <para>Classes that inherit <see cref="T:System.Data.Common.DbDataAdapter" /> must implement the inherited members, and typically define additional members to add provider-specific functionality. For example, the <see cref="T:System.Data.Common.DbDataAdapter" /> class defines the <see cref="P:System.Data.IDbDataAdapter.SelectCommand" /> property, and the <see cref="T:System.Data.Common.DbDataAdapter" /> interface defines eight overloads of the <see cref="M:System.Data.IDataAdapter.Fill(System.Data.DataSet)" /> method. In turn, the <see cref="T:System.Data.OleDb.OleDbDataAdapter" /> class inherits the <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method, and also defines two additional overloads of <see cref="M:System.Data.OleDb.OleDbDataAdapter.Fill(System.Data.DataTable,System.Object)" /> that take an ADO Recordset object as a parameter.</para>
  29. </remarks>
  30. <summary>
  31. <attribution license="cc4" from="Microsoft" modified="false" />
  32. <para>Aids implementation of the <see cref="T:System.Data.IDbDataAdapter" /> interface. Inheritors of <see cref="T:System.Data.Common.DbDataAdapter" /> implement a set of functions to provide strong typing, but inherit most of the functionality needed to fully implement a DataAdapter. </para>
  33. </summary>
  34. </Docs>
  35. <Members>
  36. <Member MemberName=".ctor">
  37. <MemberSignature Language="C#" Value="protected DbDataAdapter ();" />
  38. <MemberType>Constructor</MemberType>
  39. <ReturnValue />
  40. <Parameters />
  41. <Docs>
  42. <remarks>
  43. <attribution license="cc4" from="Microsoft" modified="false" />
  44. <para>When you create an instance of <see cref="T:System.Data.Common.DbDataAdapter" />, the following read/write properties are set to the following initial values.</para>
  45. <list type="table">
  46. <listheader>
  47. <item>
  48. <term>
  49. <para>Properties </para>
  50. </term>
  51. <description>
  52. <para>Initial value </para>
  53. </description>
  54. </item>
  55. </listheader>
  56. <item>
  57. <term>
  58. <para>
  59. <see cref="P:System.Data.IDbDataAdapter.SelectCommand" /> </para>
  60. </term>
  61. <description>
  62. <para>A new <see cref="T:System.Data.IDbCommand" />. </para>
  63. </description>
  64. </item>
  65. <item>
  66. <term>
  67. <para>
  68. <see cref="P:System.Data.IDbDataAdapter.InsertCommand" /> </para>
  69. </term>
  70. <description>
  71. <para>A new <see cref="T:System.Data.IDbCommand" />. </para>
  72. </description>
  73. </item>
  74. <item>
  75. <term>
  76. <para>
  77. <see cref="P:System.Data.IDbDataAdapter.DeleteCommand" /> </para>
  78. </term>
  79. <description>
  80. <para>A new <see cref="T:System.Data.IDbCommand" />. </para>
  81. </description>
  82. </item>
  83. <item>
  84. <term>
  85. <para>
  86. <see cref="P:System.Data.IDbDataAdapter.UpdateCommand" /> </para>
  87. </term>
  88. <description>
  89. <para>A new <see cref="T:System.Data.IDbCommand" />. </para>
  90. </description>
  91. </item>
  92. <item>
  93. <term>
  94. <para>
  95. <see cref="P:System.Data.Common.DataAdapter.MissingMappingAction" /> </para>
  96. </term>
  97. <description>
  98. <para>MissingMappingAction.Passthrough </para>
  99. </description>
  100. </item>
  101. <item>
  102. <term>
  103. <para>
  104. <see cref="P:System.Data.Common.DataAdapter.MissingSchemaAction" /> </para>
  105. </term>
  106. <description>
  107. <para>MissingSchemaAction.Add </para>
  108. </description>
  109. </item>
  110. </list>
  111. <para>You can change the value of any of these properties through a separate call to the property.</para>
  112. </remarks>
  113. <summary>
  114. <attribution license="cc4" from="Microsoft" modified="false" />
  115. <para>Initializes a new instance of a DataAdapter class.</para>
  116. </summary>
  117. </Docs>
  118. <AssemblyInfo>
  119. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  120. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  121. </AssemblyInfo>
  122. </Member>
  123. <Member MemberName=".ctor">
  124. <MemberSignature Language="C#" Value="protected DbDataAdapter (System.Data.Common.DbDataAdapter adapter);" />
  125. <MemberType>Constructor</MemberType>
  126. <AssemblyInfo>
  127. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  128. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  129. </AssemblyInfo>
  130. <Parameters>
  131. <Parameter Name="adapter" Type="System.Data.Common.DbDataAdapter" />
  132. </Parameters>
  133. <Docs>
  134. <remarks>
  135. <attribution license="cc4" from="Microsoft" modified="false" />
  136. <para>This overload of the <see cref="T:System.Data.Common.DbDataAdapter" /> constructor is designed for use by a .NET Framework data provider when implementing a similar constructor for use in a clone implementation.</para>
  137. </remarks>
  138. <summary>
  139. <attribution license="cc4" from="Microsoft" modified="false" />
  140. <para>Initializes a new instance of a DataAdapter class from an existing object of the same type.</para>
  141. </summary>
  142. <param name="adapter">
  143. <attribution license="cc4" from="Microsoft" modified="false" />A DataAdapter object used to create the new DataAdapter. </param>
  144. </Docs>
  145. </Member>
  146. <Member MemberName="AddToBatch">
  147. <MemberSignature Language="C#" Value="protected virtual int AddToBatch (System.Data.IDbCommand command);" />
  148. <MemberType>Method</MemberType>
  149. <AssemblyInfo>
  150. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  151. </AssemblyInfo>
  152. <ReturnValue>
  153. <ReturnType>System.Int32</ReturnType>
  154. </ReturnValue>
  155. <Parameters>
  156. <Parameter Name="command" Type="System.Data.IDbCommand" />
  157. </Parameters>
  158. <Docs>
  159. <remarks>
  160. <attribution license="cc4" from="Microsoft" modified="false" />
  161. <para>In <see cref="T:System.Data.Common.DbDataAdapter" />, this method throws <see cref="T:System.NotSupportedException" />. Classes that inherit from <see cref="T:System.Data.Common.DbDataAdapter" /> override this method to provide support for batches.</para>
  162. </remarks>
  163. <summary>
  164. <attribution license="cc4" from="Microsoft" modified="false" />
  165. <para>Adds a <see cref="T:System.Data.IDbCommand" /> to the current batch.</para>
  166. </summary>
  167. <returns>
  168. <attribution license="cc4" from="Microsoft" modified="false" />
  169. <para>The number of commands in the batch before adding the <see cref="T:System.Data.IDbCommand" />.</para>
  170. </returns>
  171. <param name="command">
  172. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.IDbCommand" /> to add to the batch.</param>
  173. </Docs>
  174. </Member>
  175. <Member MemberName="ClearBatch">
  176. <MemberSignature Language="C#" Value="protected virtual void ClearBatch ();" />
  177. <MemberType>Method</MemberType>
  178. <AssemblyInfo>
  179. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  180. </AssemblyInfo>
  181. <ReturnValue>
  182. <ReturnType>System.Void</ReturnType>
  183. </ReturnValue>
  184. <Parameters />
  185. <Docs>
  186. <remarks>
  187. <attribution license="cc4" from="Microsoft" modified="false" />
  188. <para>In <see cref="T:System.Data.Common.DbDataAdapter" />, this method throws <see cref="T:System.NotSupportedException" />. Classes that inherit from <see cref="T:System.Data.Common.DbDataAdapter" /> override this method to provide support for batches.</para>
  189. </remarks>
  190. <summary>
  191. <attribution license="cc4" from="Microsoft" modified="false" />
  192. <para>Removes all <see cref="T:System.Data.IDbCommand" /> objects from the batch.</para>
  193. </summary>
  194. </Docs>
  195. </Member>
  196. <Member MemberName="CreateRowUpdatedEvent">
  197. <MemberSignature Language="C#" Value="protected virtual System.Data.Common.RowUpdatedEventArgs CreateRowUpdatedEvent (System.Data.DataRow dataRow, System.Data.IDbCommand command, System.Data.StatementType statementType, System.Data.Common.DataTableMapping tableMapping);" />
  198. <MemberType>Method</MemberType>
  199. <ReturnValue>
  200. <ReturnType>System.Data.Common.RowUpdatedEventArgs</ReturnType>
  201. </ReturnValue>
  202. <Parameters>
  203. <Parameter Name="dataRow" Type="System.Data.DataRow" />
  204. <Parameter Name="command" Type="System.Data.IDbCommand" />
  205. <Parameter Name="statementType" Type="System.Data.StatementType" />
  206. <Parameter Name="tableMapping" Type="System.Data.Common.DataTableMapping" />
  207. </Parameters>
  208. <Docs>
  209. <remarks>To be added</remarks>
  210. <summary>
  211. <attribution license="cc4" from="Microsoft" modified="false" />
  212. <para>Initializes a new instance of the <see cref="T:System.Data.Common.RowUpdatedEventArgs" /> class.</para>
  213. </summary>
  214. <returns>
  215. <attribution license="cc4" from="Microsoft" modified="false" />
  216. <para>A new instance of the <see cref="T:System.Data.Common.RowUpdatedEventArgs" /> class.</para>
  217. </returns>
  218. <param name="dataRow">
  219. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.DataRow" /> used to update the data source. </param>
  220. <param name="command">
  221. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.IDbCommand" /> executed during the <see cref="M:System.Data.IDataAdapter.Update(System.Data.DataSet)" />. </param>
  222. <param name="statementType">
  223. <attribution license="cc4" from="Microsoft" modified="false" />Whether the command is an UPDATE, INSERT, DELETE, or SELECT statement. </param>
  224. <param name="tableMapping">
  225. <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Data.Common.DataTableMapping" /> object. </param>
  226. </Docs>
  227. <AssemblyInfo>
  228. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  229. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  230. </AssemblyInfo>
  231. </Member>
  232. <Member MemberName="CreateRowUpdatingEvent">
  233. <MemberSignature Language="C#" Value="protected virtual System.Data.Common.RowUpdatingEventArgs CreateRowUpdatingEvent (System.Data.DataRow dataRow, System.Data.IDbCommand command, System.Data.StatementType statementType, System.Data.Common.DataTableMapping tableMapping);" />
  234. <MemberType>Method</MemberType>
  235. <ReturnValue>
  236. <ReturnType>System.Data.Common.RowUpdatingEventArgs</ReturnType>
  237. </ReturnValue>
  238. <Parameters>
  239. <Parameter Name="dataRow" Type="System.Data.DataRow" />
  240. <Parameter Name="command" Type="System.Data.IDbCommand" />
  241. <Parameter Name="statementType" Type="System.Data.StatementType" />
  242. <Parameter Name="tableMapping" Type="System.Data.Common.DataTableMapping" />
  243. </Parameters>
  244. <Docs>
  245. <remarks>To be added</remarks>
  246. <summary>
  247. <attribution license="cc4" from="Microsoft" modified="false" />
  248. <para>Initializes a new instance of the <see cref="T:System.Data.Common.RowUpdatingEventArgs" /> class.</para>
  249. </summary>
  250. <returns>
  251. <attribution license="cc4" from="Microsoft" modified="false" />
  252. <para>A new instance of the <see cref="T:System.Data.Common.RowUpdatingEventArgs" /> class.</para>
  253. </returns>
  254. <param name="dataRow">
  255. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.DataRow" /> that updates the data source. </param>
  256. <param name="command">
  257. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.IDbCommand" /> to execute during the <see cref="M:System.Data.IDataAdapter.Update(System.Data.DataSet)" />. </param>
  258. <param name="statementType">
  259. <attribution license="cc4" from="Microsoft" modified="false" />Whether the command is an UPDATE, INSERT, DELETE, or SELECT statement. </param>
  260. <param name="tableMapping">
  261. <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Data.Common.DataTableMapping" /> object. </param>
  262. </Docs>
  263. <AssemblyInfo>
  264. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  265. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  266. </AssemblyInfo>
  267. </Member>
  268. <Member MemberName="DefaultSourceTableName">
  269. <MemberSignature Language="C#" Value="public const string DefaultSourceTableName;" />
  270. <MemberType>Field</MemberType>
  271. <ReturnValue>
  272. <ReturnType>System.String</ReturnType>
  273. </ReturnValue>
  274. <Parameters />
  275. <Docs>
  276. <remarks>
  277. <attribution license="cc4" from="Microsoft" modified="false" />
  278. <para>"Table" is the default name used by the <see cref="T:System.Data.Common.DataAdapter" /> object for table mappings.</para>
  279. <para>
  280. <see cref="F:System.Data.Common.DbDataAdapter.DefaultSourceTableName" /> is when an application adds a table mapping to be used with <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" />, but does not specify a <see cref="T:System.Data.DataTable" /> name.</para>
  281. </remarks>
  282. <summary>
  283. <attribution license="cc4" from="Microsoft" modified="false" />
  284. <para>The default name used by the <see cref="T:System.Data.Common.DataAdapter" /> object for table mappings.</para>
  285. </summary>
  286. </Docs>
  287. <AssemblyInfo>
  288. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  289. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  290. </AssemblyInfo>
  291. </Member>
  292. <Member MemberName="DeleteCommand">
  293. <MemberSignature Language="C#" Value="public System.Data.Common.DbCommand DeleteCommand { set; get; }" />
  294. <MemberType>Property</MemberType>
  295. <AssemblyInfo>
  296. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  297. </AssemblyInfo>
  298. <Attributes>
  299. <Attribute>
  300. <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
  301. </Attribute>
  302. <Attribute>
  303. <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
  304. </Attribute>
  305. </Attributes>
  306. <ReturnValue>
  307. <ReturnType>System.Data.Common.DbCommand</ReturnType>
  308. </ReturnValue>
  309. <Docs>
  310. <value>To be added.</value>
  311. <remarks>
  312. <attribution license="cc4" from="Microsoft" modified="false" />
  313. <para>During <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />, if this property is not set and primary key information is present in the <see cref="T:System.Data.DataSet" />, the <see cref="P:System.Data.IDbDataAdapter.DeleteCommand" /> is automatically generated.</para>
  314. </remarks>
  315. <summary>
  316. <attribution license="cc4" from="Microsoft" modified="false" />
  317. <para>Gets or sets a command for deleting records from the data set.</para>
  318. </summary>
  319. </Docs>
  320. </Member>
  321. <Member MemberName="Dispose">
  322. <MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
  323. <MemberType>Method</MemberType>
  324. <ReturnValue>
  325. <ReturnType>System.Void</ReturnType>
  326. </ReturnValue>
  327. <Parameters>
  328. <Parameter Name="disposing" Type="System.Boolean" />
  329. </Parameters>
  330. <Docs>
  331. <remarks>To be added</remarks>
  332. <summary>
  333. <attribution license="cc4" from="Microsoft" modified="false" />
  334. <para>Releases the unmanaged resources used by the <see cref="T:System.Data.Common.DbDataAdapter" /> and optionally releases the managed resources.</para>
  335. </summary>
  336. <param name="disposing">
  337. <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources. </param>
  338. </Docs>
  339. <AssemblyInfo>
  340. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  341. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  342. </AssemblyInfo>
  343. </Member>
  344. <Member MemberName="ExecuteBatch">
  345. <MemberSignature Language="C#" Value="protected virtual int ExecuteBatch ();" />
  346. <MemberType>Method</MemberType>
  347. <AssemblyInfo>
  348. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  349. </AssemblyInfo>
  350. <ReturnValue>
  351. <ReturnType>System.Int32</ReturnType>
  352. </ReturnValue>
  353. <Parameters />
  354. <Docs>
  355. <remarks>
  356. <attribution license="cc4" from="Microsoft" modified="false" />
  357. <para>In <see cref="T:System.Data.Common.DbDataAdapter" />, this method throws <see cref="T:System.NotSupportedException" />. Classes that inherit from <see cref="T:System.Data.Common.DbDataAdapter" /> override this method to provide support for batches.</para>
  358. </remarks>
  359. <summary>
  360. <attribution license="cc4" from="Microsoft" modified="false" />
  361. <para>Executes the current batch.</para>
  362. </summary>
  363. <returns>
  364. <attribution license="cc4" from="Microsoft" modified="false" />
  365. <para>The return value from the last command in the batch.</para>
  366. </returns>
  367. </Docs>
  368. </Member>
  369. <Member MemberName="Fill">
  370. <MemberSignature Language="C#" Value="public override int Fill (System.Data.DataSet dataSet);" />
  371. <MemberType>Method</MemberType>
  372. <ReturnValue>
  373. <ReturnType>System.Int32</ReturnType>
  374. </ReturnValue>
  375. <Parameters>
  376. <Parameter Name="dataSet" Type="System.Data.DataSet" />
  377. </Parameters>
  378. <Docs>
  379. <remarks>
  380. <attribution license="cc4" from="Microsoft" modified="false" />
  381. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method retrieves the data from the data source using a SELECT statement. The <see cref="T:System.Data.IDbConnection" /> object associated with the select command must be valid, but it does not need to be open. If the <see cref="T:System.Data.IDbConnection" /> is closed before <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called, it is opened to retrieve data and then closed. If the connection is open before <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called, it remains open.</para>
  382. <para>If an error or an exception is encountered while populating the data tables, rows added prior to the occurrence of the error remain in the data tables. The remainder of the operation is aborted.</para>
  383. <para>If a command does not return any rows, no tables are added to the <see cref="T:System.Data.DataSet" />, and no exception is raised.</para>
  384. <para>If the <see cref="T:System.Data.Common.DbDataAdapter" /> object encounters duplicate columns while populating a <see cref="T:System.Data.DataTable" />, it generates names for the subsequent columns using the pattern "columnname1", "columnname2", "columnname3", and so on. If the incoming data contains unnamed columns, they are placed in the <see cref="T:System.Data.DataSet" /> according to the pattern "Column1", "Column2", and so on.</para>
  385. <para>When the query specified returns multiple results, the result set for each row returning query is placed in a separate table. Additional result sets are named by appending integral values to the specified table name (for example, "Table", "Table1", "Table2", and so on). Because no table is created for a query that does not return rows, if you process an insert query followed by a select query, the table created for the select query is named "Table" because it is the first table created. Applications using column and table names should ensure that conflicts with these naming patterns does not occur.</para>
  386. <para>When the SELECT statement used to populate the <see cref="T:System.Data.DataSet" /> returns multiple results, such as batch SQL statements, if one of the results contains an error, all subsequent results are skipped and are not added to the <see cref="T:System.Data.DataSet" />.</para>
  387. <para>When using subsequent <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> calls to refresh the contents of the <see cref="T:System.Data.DataSet" />, two conditions must be met: </para>
  388. <list type="ordered">
  389. <item>
  390. <para>The SQL statement should match the one initially used to populate the <see cref="T:System.Data.DataSet" />.</para>
  391. </item>
  392. <item>
  393. <para>The Key column information must be present.</para>
  394. </item>
  395. </list>
  396. <para>If primary key information is present, any duplicate rows are reconciled and only appear once in the <see cref="T:System.Data.DataTable" /> that corresponds to the <see cref="T:System.Data.DataSet" />. Primary key information may be set either through <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" />, by specifying the <see cref="P:System.Data.DataTable.PrimaryKey" /> property of the <see cref="T:System.Data.DataTable" />, or by setting the <see cref="P:System.Data.Common.DataAdapter.MissingSchemaAction" /> property to AddWithKey.</para>
  397. <para>If the SelectCommand returns the results of an OUTER JOIN, the DataAdapter does not set a <see cref="P:System.Data.DataTable.PrimaryKey" /> value for the resulting <see cref="T:System.Data.DataTable" />. You must explicitly define the primary key to ensure that duplicate rows are resolved correctly. For more information, see <format type="text/html"><a href="2ea85959-e763-4669-8bd9-46a9dab894bd">Defining a Primary Key for a Table</a></format>.</para>
  398. <block subset="none" type="note">
  399. <para>When handling batch SQL statements that return multiple results, the implementation of <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> for the .NET Framework Data Provider for OLE DB retrieves schema information for only the first result. To retrieve schema information for multiple results, use <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> with the <see cref="T:System.Data.MissingSchemaAction" /> set to AddWithKey.</para>
  400. </block>
  401. </remarks>
  402. <summary>
  403. <attribution license="cc4" from="Microsoft" modified="false" />
  404. <para>Adds or refreshes rows in the <see cref="T:System.Data.DataSet" />.</para>
  405. </summary>
  406. <returns>
  407. <attribution license="cc4" from="Microsoft" modified="false" />
  408. <para>The number of rows successfully added to or refreshed in the <see cref="T:System.Data.DataSet" />. This does not include rows affected by statements that do not return rows.</para>
  409. </returns>
  410. <param name="dataSet">
  411. <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Data.DataSet" /> to fill with records and, if necessary, schema. </param>
  412. </Docs>
  413. <AssemblyInfo>
  414. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  415. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  416. </AssemblyInfo>
  417. </Member>
  418. <Member MemberName="Fill">
  419. <MemberSignature Language="C#" Value="public int Fill (System.Data.DataTable dataTable);" />
  420. <MemberType>Method</MemberType>
  421. <ReturnValue>
  422. <ReturnType>System.Int32</ReturnType>
  423. </ReturnValue>
  424. <Parameters>
  425. <Parameter Name="dataTable" Type="System.Data.DataTable" />
  426. </Parameters>
  427. <Docs>
  428. <remarks>
  429. <attribution license="cc4" from="Microsoft" modified="false" />
  430. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method retrieves rows from the data source using the SELECT statement specified by an associated <see cref="P:System.Data.IDbDataAdapter.SelectCommand" /> property. The connection object associated with the SELECT statement must be valid, but it does not need to be open. If the connection is closed before <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called, it is opened to retrieve data, then closed. If the connection is open before <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called, it remains open.</para>
  431. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> operation then adds the rows to destination <see cref="T:System.Data.DataTable" /> objects in the <see cref="T:System.Data.DataSet" />, creating the <see cref="T:System.Data.DataTable" /> objects if they do not already exist. When creating <see cref="T:System.Data.DataTable" /> objects, the <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> operation normally creates only column name metadata. However, if the <see cref="P:System.Data.IDataAdapter.MissingSchemaAction" /> property is set to AddWithKey, appropriate primary keys and constraints are also created.</para>
  432. <para>If the <see cref="T:System.Data.Common.DbDataAdapter" /> encounters duplicate columns while populating a <see cref="T:System.Data.DataTable" />, it generates names for the subsequent columns, using the pattern "columnname1", "columnname2", "columnname3", and so on. If the incoming data contains unnamed columns, they are placed in the <see cref="T:System.Data.DataSet" /> according to the pattern "Column1", "Column2", and so on. When multiple result sets are added to the <see cref="T:System.Data.DataSet" /> each result set is placed in a separate table.</para>
  433. <para>The overload of <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> that takes <paramref name="DataTable" /> as a parameter only obtains the first result. Use an overload of <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> that takes <paramref name="DataSet" /> as a parameter to obtain multiple results.</para>
  434. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method supports scenarios where the <see cref="T:System.Data.DataSet" /> contains multiple <see cref="T:System.Data.DataTable" /> objects whose names differ only by case. In such situations, <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> performs a case-sensitive comparison to find the corresponding table, and creates a new table if no exact match exists. The following C# code illustrates this behavior.</para>
  435. <code>DataSet dataset = new DataSet();
  436. dataset.Tables.Add("aaa");
  437. dataset.Tables.Add("AAA");
  438. adapter.Fill(dataset, "aaa"); // Fills "aaa", which already exists in the DataSet.
  439. adapter.Fill(dataset, "Aaa"); // Adds a new table called "Aaa".</code>
  440. <para>If <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called and the <see cref="T:System.Data.DataSet" /> contains only one <see cref="T:System.Data.DataTable" /> whose name differs only by case, that <see cref="T:System.Data.DataTable" /> is updated. In this scenario, the comparison is case insensitive. The following C# code illustrates this behavior.</para>
  441. <code>DataSet dataset = new DataSet();
  442. dataset.Tables.Add("aaa");
  443. adapter.Fill(dataset, "AAA"); // Fills table "aaa" because only one similarly named table is in the DataSet.</code>
  444. <para>You can use the <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method multiple times on the same <see cref="T:System.Data.DataTable" />. If a primary key exists, incoming rows are merged with matching rows that already exist. If no primary key exists, incoming rows are appended to the <see cref="T:System.Data.DataTable" />.</para>
  445. <para>If the SelectCommand returns the results of an OUTER JOIN, the DataAdapter does not set a <see cref="P:System.Data.DataTable.PrimaryKey" /> value for the resulting <see cref="T:System.Data.DataTable" />. You must explicitly define the primary key to ensure that duplicate rows are resolved correctly. For more information, see <format type="text/html"><a href="2ea85959-e763-4669-8bd9-46a9dab894bd">Defining a Primary Key for a Table</a></format>.</para>
  446. <block subset="none" type="note">
  447. <para>When handling batch SQL statements that return multiple results, the implementation of <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> and <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> for a .NET Framework data provider retrieves schema information for only the first result.</para>
  448. </block>
  449. </remarks>
  450. <summary>
  451. <attribution license="cc4" from="Microsoft" modified="false" />
  452. <para>Adds or refreshes rows in a specified range in the <see cref="T:System.Data.DataSet" /> to match those in the data source using the <see cref="T:System.Data.DataTable" /> name.</para>
  453. </summary>
  454. <returns>
  455. <attribution license="cc4" from="Microsoft" modified="false" />
  456. <para>The number of rows successfully added to or refreshed in the <see cref="T:System.Data.DataSet" />. This does not include rows affected by statements that do not return rows.</para>
  457. </returns>
  458. <param name="dataTable">
  459. <attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Data.DataTable" /> to use for table mapping. </param>
  460. </Docs>
  461. <AssemblyInfo>
  462. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  463. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  464. </AssemblyInfo>
  465. </Member>
  466. <Member MemberName="Fill">
  467. <MemberSignature Language="C#" Value="public int Fill (System.Data.DataSet dataSet, string srcTable);" />
  468. <MemberType>Method</MemberType>
  469. <ReturnValue>
  470. <ReturnType>System.Int32</ReturnType>
  471. </ReturnValue>
  472. <Parameters>
  473. <Parameter Name="dataSet" Type="System.Data.DataSet" />
  474. <Parameter Name="srcTable" Type="System.String" />
  475. </Parameters>
  476. <Docs>
  477. <remarks>
  478. <attribution license="cc4" from="Microsoft" modified="false" />
  479. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method retrieves the data from the data source using a SELECT statement. The <see cref="T:System.Data.IDbConnection" /> object associated with the select command must be valid, but it does not need to be open. If the <see cref="T:System.Data.IDbConnection" /> is closed before <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called, it is opened to retrieve data, then closed. If the connection is open before <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called, it remains open.</para>
  480. <para>If a command does not return any rows, no tables are added to the <see cref="T:System.Data.DataSet" />, and no exception is raised.</para>
  481. <para>If the <see cref="T:System.Data.Common.DbDataAdapter" /> object encounters duplicate columns while populating a <see cref="T:System.Data.DataTable" />, it will generate names for the subsequent columns, using the pattern "columnname1", "columnname2", "columnname3", and so on. If the incoming data contains unnamed columns, they are placed in the <see cref="T:System.Data.DataSet" /> according to the pattern "Column1", "Column2", and so on.</para>
  482. <para>When the query specified returns multiple results, each result set is placed in a separate table. Additional result sets are named by appending integral values to the specified table name (for example, "Table", "Table1", "Table2", and so on). Since no table is created for a query that does not return rows, if you were to process an insert query followed by a select query, the table created for the select query would be named "Table", because it is the first table created. Applications using column and table names should ensure that conflicts with these naming patterns does not occur.</para>
  483. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method supports scenarios where the <see cref="T:System.Data.DataSet" /> contains multiple <see cref="T:System.Data.DataTable" /> objects whose names differ only by case. In such situations, <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> performs a case-sensitive comparison to find the corresponding table, and creates a new table if no exact match exists. The following C# code illustrates this behavior.</para>
  484. <code> DataSet dataset = new DataSet();
  485. dataset.Tables.Add("aaa");
  486. dataset.Tables.Add("AAA");
  487. adapter.Fill(dataset, "aaa"); // Fills "aaa", which already exists in the DataSet.
  488. adapter.Fill(dataset, "Aaa"); // Adds a new table called "Aaa".</code>
  489. <para>If <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called and the <see cref="T:System.Data.DataSet" /> contains only one <see cref="T:System.Data.DataTable" /> whose name differs only by case, that <see cref="T:System.Data.DataTable" /> is updated. In this scenario, the comparison is case insensitive. The following C# code illustrates this behavior.</para>
  490. <code> DataSet dataset = new DataSet();
  491. dataset.Tables.Add("aaa");
  492. adapter.Fill(dataset, "AAA"); // Fills table "aaa" because only one similarly named table is in the DataSet.</code>
  493. <para>If an error or an exception is encountered while populating the data tables, rows added prior to the occurrence of the error remain in the data tables. The remainder of the operation is aborted.</para>
  494. <para>When the SELECT statement used to populate the <see cref="T:System.Data.DataSet" /> returns multiple results, such as a batch SQL statement, be aware of the following: </para>
  495. <list type="bullet">
  496. <item>
  497. <para>If one of the results contains an error, all subsequent results are skipped and not added to the <see cref="T:System.Data.DataSet" />.</para>
  498. </item>
  499. </list>
  500. <para>When using subsequent <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> calls to refresh the contents of the <see cref="T:System.Data.DataSet" />, two conditions must be met: </para>
  501. <list type="ordered">
  502. <item>
  503. <para>The SQL statement should match the one initially used to populate the <see cref="T:System.Data.DataSet" />.</para>
  504. </item>
  505. <item>
  506. <para>The Key column information must be present. If primary key information is present, any duplicate rows are reconciled and only appear once in the <see cref="T:System.Data.DataTable" /> that corresponds to the <see cref="T:System.Data.DataSet" />. Primary key information may be set either through <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" />, by specifying the <see cref="P:System.Data.DataTable.PrimaryKey" /> property of the <see cref="T:System.Data.DataTable" />, or by setting the <see cref="P:System.Data.Common.DataAdapter.MissingSchemaAction" /> property to AddWithKey.</para>
  507. </item>
  508. </list>
  509. <para>If the SelectCommand returns the results of an OUTER JOIN, the DataAdapter does not set a <see cref="P:System.Data.DataTable.PrimaryKey" /> value for the resulting <see cref="T:System.Data.DataTable" />. You must explicitly define the primary key to ensure that duplicate rows are resolved correctly. For more information, see<format type="text/html"><a href="2ea85959-e763-4669-8bd9-46a9dab894bd"> Defining a Primary Key for a Table</a></format>.</para>
  510. <block subset="none" type="note">
  511. <para>When handling batch SQL statements that return multiple results, the implementation of <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> for the .NET Framework Data Provider for OLE DB retrieves schema information for only the first result. To retrieve schema information for multiple results, use <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> with the <see cref="T:System.Data.MissingSchemaAction" /> set to AddWithKey.</para>
  512. </block>
  513. </remarks>
  514. <summary>
  515. <attribution license="cc4" from="Microsoft" modified="false" />
  516. <para>Adds or refreshes rows in the <see cref="T:System.Data.DataSet" /> to match those in the data source using the <see cref="T:System.Data.DataSet" /> and <see cref="T:System.Data.DataTable" /> names.</para>
  517. </summary>
  518. <returns>
  519. <attribution license="cc4" from="Microsoft" modified="false" />
  520. <para>The number of rows successfully added to or refreshed in the <see cref="T:System.Data.DataSet" />. This does not include rows affected by statements that do not return rows.</para>
  521. </returns>
  522. <param name="dataSet">
  523. <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Data.DataSet" /> to fill with records and, if necessary, schema. </param>
  524. <param name="srcTable">
  525. <attribution license="cc4" from="Microsoft" modified="false" />The name of the source table to use for table mapping. </param>
  526. </Docs>
  527. <AssemblyInfo>
  528. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  529. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  530. </AssemblyInfo>
  531. </Member>
  532. <Member MemberName="Fill">
  533. <MemberSignature Language="C#" Value="protected virtual int Fill (System.Data.DataTable dataTable, System.Data.IDataReader dataReader);" />
  534. <MemberType>Method</MemberType>
  535. <AssemblyInfo>
  536. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  537. </AssemblyInfo>
  538. <ReturnValue>
  539. <ReturnType>System.Int32</ReturnType>
  540. </ReturnValue>
  541. <Parameters>
  542. <Parameter Name="dataTable" Type="System.Data.DataTable" />
  543. <Parameter Name="dataReader" Type="System.Data.IDataReader" />
  544. </Parameters>
  545. <Docs>
  546. <param name="dataTable">To be added.</param>
  547. <param name="dataReader">To be added.</param>
  548. <summary>To be added.</summary>
  549. <returns>To be added.</returns>
  550. <remarks>To be added.</remarks>
  551. </Docs>
  552. </Member>
  553. <Member MemberName="Fill">
  554. <MemberSignature Language="C#" Value="protected virtual int Fill (System.Data.DataTable dataTable, System.Data.IDbCommand command, System.Data.CommandBehavior behavior);" />
  555. <MemberType>Method</MemberType>
  556. <ReturnValue>
  557. <ReturnType>System.Int32</ReturnType>
  558. </ReturnValue>
  559. <Parameters>
  560. <Parameter Name="dataTable" Type="System.Data.DataTable" />
  561. <Parameter Name="command" Type="System.Data.IDbCommand" />
  562. <Parameter Name="behavior" Type="System.Data.CommandBehavior" />
  563. </Parameters>
  564. <Docs>
  565. <remarks>
  566. <attribution license="cc4" from="Microsoft" modified="false" />
  567. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method retrieves rows from the data source using the SELECT statement specified by an associated <see cref="P:System.Data.IDbDataAdapter.SelectCommand" /> property. The connection object associated with the SELECT statement must be valid, but it does not need to be open. If the connection is closed before <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called, it is opened to retrieve data and then closed. If the connection is open before <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called, it remains open.</para>
  568. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> operation then adds the rows to the specified destination <see cref="T:System.Data.DataTable" /> object in the <see cref="T:System.Data.DataSet" />, creating the <see cref="T:System.Data.DataTable" /> object if it does not already exist. When creating a <see cref="T:System.Data.DataTable" /> object, the <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> operation normally creates only column name metadata. However, if the <see cref="P:System.Data.IDataAdapter.MissingSchemaAction" /> property is set to AddWithKey, appropriate primary keys and constraints are also created.</para>
  569. <para>If the <see cref="T:System.Data.Common.DbDataAdapter" /> object encounters duplicate columns while populating a <see cref="T:System.Data.DataTable" />, it will generate names for the subsequent columns, using the pattern "columnname1", "columnname2", "columnname3", and so on. If the incoming data contains unnamed columns, they are placed in the <see cref="T:System.Data.DataSet" /> according to the pattern "Column1", "Column2", and so on.</para>
  570. <para>The overload of <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> that takes <paramref name="DataTable" /> as a parameter only obtains the first result. Use an overload of <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> that takes <paramref name="DataSet" /> as a parameter to obtain multiple results.</para>
  571. <para>You can use the <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method multiple times on the same <see cref="T:System.Data.DataTable" />. If a primary key exists, incoming rows are merged with matching rows that already exist. If no primary key exists, incoming rows are appended to the <see cref="T:System.Data.DataTable" />.</para>
  572. <para>If the SelectCommand returns the results of an OUTER JOIN, the DataAdapter does not set a <see cref="P:System.Data.DataTable.PrimaryKey" /> value for the resulting <see cref="T:System.Data.DataTable" />. You must explicitly define the primary key to ensure that duplicate rows are resolved correctly. For more information, see <format type="text/html"><a href="2ea85959-e763-4669-8bd9-46a9dab894bd">Defining a Primary Key for a Table</a></format>.</para>
  573. <block subset="none" type="note">
  574. <para>When handling batch SQL statements that return multiple results, the implementation of <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> for the .NET Framework Data Provider for OLE DB retrieves schema information for only the first result. To retrieve schema information for multiple results, use <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> with the <see cref="T:System.Data.MissingSchemaAction" /> set to AddWithKey.</para>
  575. </block>
  576. </remarks>
  577. <summary>
  578. <attribution license="cc4" from="Microsoft" modified="false" />
  579. <para>Adds or refreshes rows in a <see cref="T:System.Data.DataTable" /> to match those in the data source using the specified <see cref="T:System.Data.DataTable" />, <see cref="T:System.Data.IDbCommand" /> and <see cref="T:System.Data.CommandBehavior" />.</para>
  580. </summary>
  581. <returns>
  582. <attribution license="cc4" from="Microsoft" modified="false" />
  583. <para>The number of rows successfully added to or refreshed in the <see cref="T:System.Data.DataTable" />. This does not include rows affected by statements that do not return rows.</para>
  584. </returns>
  585. <param name="dataTable">
  586. <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Data.DataTable" /> to fill with records and, if necessary, schema. </param>
  587. <param name="command">
  588. <attribution license="cc4" from="Microsoft" modified="false" />The SQL SELECT statement used to retrieve rows from the data source. </param>
  589. <param name="behavior">
  590. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.CommandBehavior" /> values.</param>
  591. </Docs>
  592. <AssemblyInfo>
  593. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  594. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  595. </AssemblyInfo>
  596. </Member>
  597. <Member MemberName="Fill">
  598. <MemberSignature Language="C#" Value="public int Fill (int startRecord, int maxRecords, System.Data.DataTable[] dataTables);" />
  599. <MemberType>Method</MemberType>
  600. <AssemblyInfo>
  601. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  602. </AssemblyInfo>
  603. <ReturnValue>
  604. <ReturnType>System.Int32</ReturnType>
  605. </ReturnValue>
  606. <Parameters>
  607. <Parameter Name="startRecord" Type="System.Int32" />
  608. <Parameter Name="maxRecords" Type="System.Int32" />
  609. <Parameter Name="dataTables" Type="System.Data.DataTable[]">
  610. <Attributes>
  611. <Attribute>
  612. <AttributeName>System.ParamArray</AttributeName>
  613. </Attribute>
  614. </Attributes>
  615. </Parameter>
  616. </Parameters>
  617. <Docs>
  618. <remarks>
  619. <attribution license="cc4" from="Microsoft" modified="false" />
  620. <para>The <see cref="M:System.Data.Common.DataAdapter.Fill(System.Data.DataSet)" /> method retrieves rows from the data source using the SELECT statement specified by an associated <see cref="P:System.Data.IDbDataAdapter.SelectCommand" /> property. The connection object associated with the SELECT statement must be valid, but it does not need to be open. If the connection is closed before <see cref="M:System.Data.Common.DataAdapter.Fill(System.Data.DataSet)" /> is called, it is opened to retrieve data, and then it is closed. If the connection is open before <see cref="M:System.Data.Common.DataAdapter.Fill(System.Data.DataSet)" /> is called, it remains open.</para>
  621. <para>The <see cref="M:System.Data.Common.DataAdapter.Fill(System.Data.DataSet)" /> operation then adds the rows to destination <see cref="T:System.Data.DataTable" /> objects in the <see cref="T:System.Data.DataSet" />, creating the <see cref="T:System.Data.DataTable" /> objects if they do not already exist. When creating <see cref="T:System.Data.DataTable" /> objects, the <see cref="M:System.Data.Common.DataAdapter.Fill(System.Data.DataSet)" /> operation normally creates only column name metadata. However, if the <see cref="P:System.Data.IDataAdapter.MissingSchemaAction" /> property is set to AddWithKey, appropriate primary keys and constraints are also created.</para>
  622. <para>If the SelectCommand returns the results of an OUTER JOIN, the DataAdapter does not set a <see cref="P:System.Data.DataTable.PrimaryKey" /> value for the resulting <see cref="T:System.Data.DataTable" />. You must explicitly define the primary key to ensure that duplicate rows are resolved correctly. For more information, see <format type="text/html"><a href="2EA85959-E763-4669-8BD9-46A9DAB894BD">Defining a Primary Key for a Table</a></format>.</para>
  623. <para>If the data adapter encounters duplicate columns while populating a <see cref="T:System.Data.DataTable" />, it generates names for the subsequent columns, using the pattern "columnname1", "columnname2", "columnname3", and so on. If the incoming data contains unnamed columns, they are placed in the <see cref="T:System.Data.DataSet" /> according to the pattern "Column1", "Column2", and so on. When multiple result sets are added to the <see cref="T:System.Data.DataSet" />, each result set is placed in a separate table. Additional result sets are named by appending integral values to the specified table name (for example, "Table", "Table1", "Table2", and so on). Applications using column and table names should ensure that conflicts with these naming patterns does not occur.</para>
  624. <para>When the SELECT statement used to populate the <see cref="T:System.Data.DataSet" /> returns multiple results, such as a batch SQL statements, if one of the results contains an error, all subsequent results are skipped and not added to the <see cref="T:System.Data.DataSet" />.</para>
  625. <para>You can use the <see cref="M:System.Data.Common.DataAdapter.Fill(System.Data.DataSet)" /> method multiple times on the same <see cref="T:System.Data.DataTable" />. If a primary key exists, incoming rows are merged with matching rows that already exist. If no primary key exists, incoming rows are appended to the <see cref="T:System.Data.DataTable" />.</para>
  626. <block subset="none" type="note">
  627. <para>When handling batch SQL statements that return multiple results, the implementation of <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> for the .NET Framework Data Provider for OLE DB retrieves schema information for only the first result. To retrieve schema information for multiple results, use <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> with the <see cref="T:System.Data.MissingSchemaAction" /> set to AddWithKey.</para>
  628. </block>
  629. </remarks>
  630. <summary>
  631. <attribution license="cc4" from="Microsoft" modified="false" />
  632. <para>Adds or refreshes rows in a <see cref="T:System.Data.DataTable" /> to match those in the data source starting at the specified record and retrieving up to the specified maximum number of records.</para>
  633. </summary>
  634. <returns>
  635. <attribution license="cc4" from="Microsoft" modified="false" />
  636. <para>The number of rows successfully added to or refreshed in the <see cref="T:System.Data.DataTable" />. This value does not include rows affected by statements that do not return rows.</para>
  637. </returns>
  638. <param name="startRecord">
  639. <attribution license="cc4" from="Microsoft" modified="false" />The zero-based record number to start with. </param>
  640. <param name="maxRecords">
  641. <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of records to retrieve. </param>
  642. <param name="dataTables">
  643. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.DataTable" /> objects to fill from the data source.</param>
  644. </Docs>
  645. </Member>
  646. <Member MemberName="Fill">
  647. <MemberSignature Language="C#" Value="public int Fill (System.Data.DataSet dataSet, int startRecord, int maxRecords, string srcTable);" />
  648. <MemberType>Method</MemberType>
  649. <ReturnValue>
  650. <ReturnType>System.Int32</ReturnType>
  651. </ReturnValue>
  652. <Parameters>
  653. <Parameter Name="dataSet" Type="System.Data.DataSet" />
  654. <Parameter Name="startRecord" Type="System.Int32" />
  655. <Parameter Name="maxRecords" Type="System.Int32" />
  656. <Parameter Name="srcTable" Type="System.String" />
  657. </Parameters>
  658. <Docs>
  659. <remarks>
  660. <attribution license="cc4" from="Microsoft" modified="false" />
  661. <para>A <paramref name="maxRecords" /> value of 0 gets all records found after the start record. If <paramref name="maxRecords" /> is greater than the number of remaining rows, only the remaining rows are returned, and no error is issued.</para>
  662. <para>If the corresponding select command is a statement returning multiple results, <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> only applies <paramref name="maxRecords" /> to the first result.</para>
  663. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method retrieves the data from the data source using a SELECT statement. The <see cref="T:System.Data.IDbConnection" /> object associated with the SELECT statement must be valid, but it does not need to be open. If the <see cref="T:System.Data.IDbConnection" /> is closed before <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called, it is opened to retrieve data and then closed. If the connection is open before <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called, it remains open.</para>
  664. <para>If a command does not return any rows, no tables are added to the <see cref="T:System.Data.DataSet" />, but no exception is raised.</para>
  665. <para>If the <see cref="T:System.Data.Common.DbDataAdapter" /> object encounters duplicate columns while populating a <see cref="T:System.Data.DataTable" />, it will generate names for the subsequent columns, using the pattern "columnname1", "columnname2", "columnname3", and so on. If the incoming data contains unnamed columns, they are placed in the <see cref="T:System.Data.DataSet" /> according to the pattern "Column1", "Column2", and so on.</para>
  666. <para>When the query specified returns multiple results, each result set is placed in a separate table. Additional result sets are named by appending integral values to the specified table name (for example, "Table", "Table1", "Table2", and so on). Because no table is created for a query that does not return rows, if you process an insert query followed by a select query, the table created for the select query is named "Table", because it is the first table created. Applications using column and table names should ensure that conflicts with these naming patterns does not occur.</para>
  667. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method supports scenarios where the <see cref="T:System.Data.DataSet" /> contains multiple <see cref="T:System.Data.DataTable" /> objects whose names differ only by case. In such situations, <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> performs a case-sensitive comparison to find the corresponding table, and creates a new table if no exact match exists. The following C# code illustrates this behavior.</para>
  668. <code>DataSet dataset = new DataSet();
  669. dataset.Tables.Add("aaa");
  670. dataset.Tables.Add("AAA");
  671. adapter.Fill(dataset, "aaa"); // Fills "aaa", which already exists in the DataSet.
  672. adapter.Fill(dataset, "Aaa"); // Adds a new table called "Aaa".</code>
  673. <para>If <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called and the <see cref="T:System.Data.DataSet" /> contains only one <see cref="T:System.Data.DataTable" /> whose name differs only by case, that <see cref="T:System.Data.DataTable" /> is updated. In this scenario, the comparison is case insensitive. The following C# code illustrates this behavior.</para>
  674. <code>DataSet dataset = new DataSet();
  675. dataset.Tables.Add("aaa");
  676. adapter.Fill(dataset, "AAA"); // Fills table "aaa" because only one similarly named table is in the DataSet.</code>
  677. <para>If an error or an exception is encountered while populating the data tables, rows added prior to the occurrence of the error remain in the data tables. The remainder of the operation is aborted.</para>
  678. <para>When the SELECT statement used to populate the <see cref="T:System.Data.DataSet" /> returns multiple results, such as batch SQL statements, be aware of the following: </para>
  679. <list type="bullet">
  680. <item>
  681. <para>When processing multiple results from a batch SQL statement, <paramref name="maxRecords" /> only applies to the first result. The same is true for rows containing chaptered results (.NET Framework Data Provider for OLE DB only). The top level result is limited by <paramref name="maxRecords" />, but all child rows are added.</para>
  682. </item>
  683. <item>
  684. <para>If one of the results contains an error, all subsequent results are skipped and not added to the <see cref="T:System.Data.DataSet" />.</para>
  685. </item>
  686. </list>
  687. <para>When using subsequent <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> calls to refresh the contents of the <see cref="T:System.Data.DataSet" />, two conditions must be met: </para>
  688. <list type="ordered">
  689. <item>
  690. <para>The SQL statement should match the one initially used to populate the <see cref="T:System.Data.DataSet" />.</para>
  691. </item>
  692. <item>
  693. <para>The Key column information must be present.</para>
  694. </item>
  695. </list>
  696. <para>If primary key information is present, any duplicate rows will be reconciled and only appear once in the <see cref="T:System.Data.DataTable" /> that corresponds to the <see cref="T:System.Data.DataSet" />. Primary key information may be set either through <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" />, by specifying the <see cref="P:System.Data.DataTable.PrimaryKey" /> property of the <see cref="T:System.Data.DataTable" />, or by setting the <see cref="P:System.Data.Common.DataAdapter.MissingSchemaAction" /> property to AddWithKey.</para>
  697. <para>If the SelectCommand returns the results of an OUTER JOIN, the DataAdapter does not set a <see cref="P:System.Data.DataTable.PrimaryKey" /> value for the resulting <see cref="T:System.Data.DataTable" />. You must explicitly define the primary key to ensure that duplicate rows are resolved correctly. For more information, see <format type="text/html"><a href="2ea85959-e763-4669-8bd9-46a9dab894bd">Defining a Primary Key for a Table</a></format>.</para>
  698. <block subset="none" type="note">
  699. <para>When handling batch SQL statements that return multiple results, the implementation of <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> for the .NET Framework Data Provider for OLE DB retrieves schema information for only the first result. To retrieve schema information for multiple results, use <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> with the <see cref="T:System.Data.MissingSchemaAction" /> set to AddWithKey.</para>
  700. </block>
  701. <block subset="none" type="note">
  702. <para>The DataSet will not contain more than the number of records indicated by <paramref name="maxRecords" />. However, the entire result set generated by the query is still returned from the server.</para>
  703. </block>
  704. </remarks>
  705. <summary>
  706. <attribution license="cc4" from="Microsoft" modified="false" />
  707. <para>Adds or refreshes rows in a specified range in the <see cref="T:System.Data.DataSet" /> to match those in the data source using the <see cref="T:System.Data.DataSet" /> and <see cref="T:System.Data.DataTable" /> names.</para>
  708. </summary>
  709. <returns>
  710. <attribution license="cc4" from="Microsoft" modified="false" />
  711. <para>The number of rows successfully added to or refreshed in the <see cref="T:System.Data.DataSet" />. This does not include rows affected by statements that do not return rows.</para>
  712. </returns>
  713. <param name="dataSet">
  714. <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Data.DataSet" /> to fill with records and, if necessary, schema. </param>
  715. <param name="startRecord">
  716. <attribution license="cc4" from="Microsoft" modified="false" />The zero-based record number to start with. </param>
  717. <param name="maxRecords">
  718. <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of records to retrieve. </param>
  719. <param name="srcTable">
  720. <attribution license="cc4" from="Microsoft" modified="false" />The name of the source table to use for table mapping. </param>
  721. </Docs>
  722. <AssemblyInfo>
  723. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  724. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  725. </AssemblyInfo>
  726. </Member>
  727. <Member MemberName="Fill">
  728. <MemberSignature Language="C#" Value="protected virtual int Fill (System.Data.DataSet dataSet, string srcTable, System.Data.IDataReader dataReader, int startRecord, int maxRecords);" />
  729. <MemberType>Method</MemberType>
  730. <ReturnValue>
  731. <ReturnType>System.Int32</ReturnType>
  732. </ReturnValue>
  733. <Parameters>
  734. <Parameter Name="dataSet" Type="System.Data.DataSet" />
  735. <Parameter Name="srcTable" Type="System.String" />
  736. <Parameter Name="dataReader" Type="System.Data.IDataReader" />
  737. <Parameter Name="startRecord" Type="System.Int32" />
  738. <Parameter Name="maxRecords" Type="System.Int32" />
  739. </Parameters>
  740. <Docs>
  741. <param name="dataSet">To be added: an object of type 'Data.DataSet'</param>
  742. <param name="srcTable">To be added: an object of type 'string'</param>
  743. <param name="dataReader">To be added: an object of type 'Data.IDataReader'</param>
  744. <param name="startRecord">To be added: an object of type 'int'</param>
  745. <param name="maxRecords">To be added: an object of type 'int'</param>
  746. <summary>To be added</summary>
  747. <returns>To be added: an object of type 'int'</returns>
  748. <remarks>To be added</remarks>
  749. </Docs>
  750. <AssemblyInfo>
  751. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  752. </AssemblyInfo>
  753. </Member>
  754. <Member MemberName="Fill">
  755. <MemberSignature Language="C#" Value="protected virtual int Fill (System.Data.DataTable[] dataTables, int startRecord, int maxRecords, System.Data.IDbCommand command, System.Data.CommandBehavior behavior);" />
  756. <MemberType>Method</MemberType>
  757. <AssemblyInfo>
  758. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  759. </AssemblyInfo>
  760. <ReturnValue>
  761. <ReturnType>System.Int32</ReturnType>
  762. </ReturnValue>
  763. <Parameters>
  764. <Parameter Name="dataTables" Type="System.Data.DataTable[]" />
  765. <Parameter Name="startRecord" Type="System.Int32" />
  766. <Parameter Name="maxRecords" Type="System.Int32" />
  767. <Parameter Name="command" Type="System.Data.IDbCommand" />
  768. <Parameter Name="behavior" Type="System.Data.CommandBehavior" />
  769. </Parameters>
  770. <Docs>
  771. <remarks>
  772. <attribution license="cc4" from="Microsoft" modified="false" />
  773. <para>A <paramref name="maxRecords" /> value of 0 gets all records found after the start record. If <paramref name="maxRecords" /> is greater than the number of remaining rows, only the remaining rows are returned and no error is issued.</para>
  774. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable[],System.Int32,System.Int32,System.Data.IDbCommand,System.Data.CommandBehavior)" /> method retrieves the data from the data source using a SELECT statement. The <see cref="T:System.Data.IDbConnection" /> object associated with the SELECT statement must be valid, but it does not need to be open. If the <see cref="T:System.Data.IDbConnection" /> is closed before <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called, it is opened to retrieve data, then closed. If the connection is open before <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called, it remains open.</para>
  775. <para>If a command does not return any rows, no tables are added to the <see cref="T:System.Data.DataSet" />, but no exception is raised.</para>
  776. <para>If the <see cref="T:System.Data.Common.DbDataAdapter" /> object encounters duplicate columns while populating a <see cref="T:System.Data.DataTable" />, it will generate names for the subsequent columns, using the pattern "columnname1", "columnname2", "columnname3", and so on. If the incoming data contains unnamed columns, they are placed in the <see cref="T:System.Data.DataSet" /> according to the pattern "Column1", "Column2", and so on.</para>
  777. <para>When the query specified returns multiple results, each result set is placed in a separate table. Additional result sets are named by appending integral values to the specified table name (for example, "Table", "Table1", "Table2", and so on). Since no table is created for a query that does not return rows, if you were to process an insert query followed by a select query, the table created for the select query would be named "Table", because it is the first table created. Applications using column and table names should ensure that conflicts with these naming patterns does not occur.</para>
  778. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataTable[],System.Int32,System.Int32,System.Data.IDbCommand,System.Data.CommandBehavior)" /> method supports scenarios where the <see cref="T:System.Data.DataSet" /> contains multiple <see cref="T:System.Data.DataTable" /> objects whose names differ only by case. In such situations, <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> performs a case-sensitive comparison to find the corresponding table, and creates a new table if no exact match exists. The following C# code illustrates this behavior.</para>
  779. <code> DataSet dataset = new DataSet();
  780. dataset.Tables.Add("aaa");
  781. dataset.Tables.Add("AAA");
  782. adapter.Fill(dataset, "aaa"); // Fills "aaa", which already exists in the DataSet.
  783. adapter.Fill(dataset, "Aaa"); // Adds a new table called "Aaa".</code>
  784. <para>If <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called and the <see cref="T:System.Data.DataSet" /> contains only one <see cref="T:System.Data.DataTable" /> whose name differs only by case, that <see cref="T:System.Data.DataTable" /> is updated. In this scenario, the comparison is case insensitive. The following C# code illustrates this behavior.</para>
  785. <code> DataSet dataset = new DataSet();
  786. dataset.Tables.Add("aaa");
  787. adapter.Fill(dataset, "AAA"); // Fills table "aaa" because only one similarly named table is in the DataSet.</code>
  788. <para>If an error or an exception is encountered while populating the data tables, rows added prior to the occurrence of the error remain in the data tables. The remainder of the operation is aborted.</para>
  789. <para>When the SELECT statement used to populate the <see cref="T:System.Data.DataTable" /> objects returns multiple results, such as a batch SQL statement, be aware of the following: </para>
  790. <list type="bullet">
  791. <item>
  792. <para>When processing multiple results from a batch SQL statement, <paramref name="maxRecords" /> only applies to the first result. The same is true for rows containing chaptered results (.NET Framework Data Provider for OLE DB only). The top level result is limited by <paramref name="maxRecords" />, but all child rows are added.</para>
  793. </item>
  794. <item>
  795. <para>If one of the results contains an error, all subsequent results are skipped.</para>
  796. </item>
  797. </list>
  798. <block subset="none" type="note">
  799. <para>The DataSet will not contain more than the number of records indicated by <paramref name="maxRecords" />. However, the entire resultset generated by the query is still returned from the server.</para>
  800. </block>
  801. </remarks>
  802. <summary>
  803. <attribution license="cc4" from="Microsoft" modified="false" />
  804. <para>Adds or refreshes rows in a specified range in the <see cref="T:System.Data.DataSet" /> to match those in the data source using the <see cref="T:System.Data.DataSet" /> and <see cref="T:System.Data.DataTable" /> names.</para>
  805. </summary>
  806. <returns>
  807. <attribution license="cc4" from="Microsoft" modified="false" />
  808. <para>The number of rows added to or refreshed in the data tables.</para>
  809. </returns>
  810. <param name="dataTables">
  811. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.DataTable" /> objects to fill from the data source.</param>
  812. <param name="startRecord">
  813. <attribution license="cc4" from="Microsoft" modified="false" />The zero-based record number to start with.</param>
  814. <param name="maxRecords">
  815. <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of records to retrieve.</param>
  816. <param name="command">
  817. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.IDbCommand" /> executed to fill the <see cref="T:System.Data.DataTable" /> objects.</param>
  818. <param name="behavior">
  819. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.CommandBehavior" /> values.</param>
  820. </Docs>
  821. </Member>
  822. <Member MemberName="Fill">
  823. <MemberSignature Language="C#" Value="protected virtual int Fill (System.Data.DataSet dataSet, int startRecord, int maxRecords, string srcTable, System.Data.IDbCommand command, System.Data.CommandBehavior behavior);" />
  824. <MemberType>Method</MemberType>
  825. <ReturnValue>
  826. <ReturnType>System.Int32</ReturnType>
  827. </ReturnValue>
  828. <Parameters>
  829. <Parameter Name="dataSet" Type="System.Data.DataSet" />
  830. <Parameter Name="startRecord" Type="System.Int32" />
  831. <Parameter Name="maxRecords" Type="System.Int32" />
  832. <Parameter Name="srcTable" Type="System.String" />
  833. <Parameter Name="command" Type="System.Data.IDbCommand" />
  834. <Parameter Name="behavior" Type="System.Data.CommandBehavior" />
  835. </Parameters>
  836. <Docs>
  837. <remarks>
  838. <attribution license="cc4" from="Microsoft" modified="false" />
  839. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method retrieves rows from the data source using the SELECT statement specified by an associated <see cref="P:System.Data.IDbDataAdapter.SelectCommand" /> property. The connection object associated with the SELECT statement must be valid, but it does not need to be open. If the connection is closed before <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called, it is opened to retrieve data, then closed. If the connection is open before <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called, it remains open.</para>
  840. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> operation then adds the rows to destination <see cref="T:System.Data.DataTable" /> objects in the <see cref="T:System.Data.DataSet" />, creating the <see cref="T:System.Data.DataTable" /> objects if they do not already exist. When creating <see cref="T:System.Data.DataTable" /> objects, the <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> operation normally creates only column name metadata. However, if the <see cref="P:System.Data.IDataAdapter.MissingSchemaAction" /> property is set to AddWithKey, appropriate primary keys and constraints are also created.</para>
  841. <para>If the <see cref="T:System.Data.Common.DbDataAdapter" /> encounters duplicate columns while populating a <see cref="T:System.Data.DataTable" />, it generates names for the subsequent columns, using the pattern "columnname1", "columnname2", "columnname3", and so on. If the incoming data contains unnamed columns, they are placed in the <see cref="T:System.Data.DataSet" /> according to the pattern "Column1", "Column2", and so on. When multiple result sets are added to the <see cref="T:System.Data.DataSet" /> each result set is placed in a separate table. Additional result sets are named by appending integral values to the specified table name (for example, "Table", "Table1", "Table2", and so on). Applications using column and table names should ensure that conflicts with these naming patterns does not occur.</para>
  842. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method supports scenarios where the <see cref="T:System.Data.DataSet" /> contains multiple <see cref="T:System.Data.DataTable" /> objects whose names differ only by case. In such situations, <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> performs a case-sensitive comparison to find the corresponding table, and creates a new table if no exact match exists. The following C# code illustrates this behavior.</para>
  843. <code> DataSet dataset = new DataSet();
  844. dataset.Tables.Add("aaa");
  845. dataset.Tables.Add("AAA");
  846. adapter.Fill(dataset, "aaa"); // Fills "aaa", which already exists in the DataSet.
  847. adapter.Fill(dataset, "Aaa"); // Adds a new table called "Aaa".</code>
  848. <para>If <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> is called and the <see cref="T:System.Data.DataSet" /> contains only one <see cref="T:System.Data.DataTable" /> whose name differs only by case, that <see cref="T:System.Data.DataTable" /> is updated. In this scenario, the comparison is case insensitive. The following C# code illustrates this behavior.</para>
  849. <code> DataSet dataset = new DataSet();
  850. dataset.Tables.Add("aaa");
  851. adapter.Fill(dataset, "AAA"); // Fills table "aaa" because only one similarly named table is in the DataSet.</code>
  852. <para>You can use the <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method multiple times on the same <see cref="T:System.Data.DataTable" />. If a primary key exists, incoming rows are merged with matching rows that already exist. If no primary key exists, incoming rows are appended to the <see cref="T:System.Data.DataTable" />.</para>
  853. <para>If the SelectCommand returns the results of an OUTER JOIN, the DataAdapter does not set a <see cref="P:System.Data.DataTable.PrimaryKey" /> value for the resulting <see cref="T:System.Data.DataTable" />. You must explicitly define the primary key to ensure that duplicate rows are resolved correctly. For more information, see<format type="text/html"><a href="2ea85959-e763-4669-8bd9-46a9dab894bd"> Defining a Primary Key for a Table</a></format>.</para>
  854. <block subset="none" type="note">
  855. <para>When handling batch SQL statements that return multiple results, the implementation of <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> and <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> for a .NET Framework data provider retrieves schema information for only the first result.</para>
  856. </block>
  857. </remarks>
  858. <summary>
  859. <attribution license="cc4" from="Microsoft" modified="false" />
  860. <para>Adds or refreshes rows in a specified range in the <see cref="T:System.Data.DataSet" /> to match those in the data source using the <see cref="T:System.Data.DataSet" /> and source table names, command string, and command behavior.</para>
  861. </summary>
  862. <returns>
  863. <attribution license="cc4" from="Microsoft" modified="false" />
  864. <para>The number of rows successfully added to or refreshed in the <see cref="T:System.Data.DataSet" />. This does not include rows affected by statements that do not return rows.</para>
  865. </returns>
  866. <param name="dataSet">
  867. <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Data.DataSet" /> to fill with records and, if necessary, schema. </param>
  868. <param name="startRecord">
  869. <attribution license="cc4" from="Microsoft" modified="false" />The zero-based record number to start with. </param>
  870. <param name="maxRecords">
  871. <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of records to retrieve. </param>
  872. <param name="srcTable">
  873. <attribution license="cc4" from="Microsoft" modified="false" />The name of the source table to use for table mapping. </param>
  874. <param name="command">
  875. <attribution license="cc4" from="Microsoft" modified="false" />The SQL SELECT statement used to retrieve rows from the data source. </param>
  876. <param name="behavior">
  877. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.CommandBehavior" /> values. </param>
  878. </Docs>
  879. <AssemblyInfo>
  880. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  881. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  882. </AssemblyInfo>
  883. </Member>
  884. <Member MemberName="FillCommandBehavior">
  885. <MemberSignature Language="C#" Value="protected System.Data.CommandBehavior FillCommandBehavior { set; get; }" />
  886. <MemberType>Property</MemberType>
  887. <AssemblyInfo>
  888. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  889. </AssemblyInfo>
  890. <ReturnValue>
  891. <ReturnType>System.Data.CommandBehavior</ReturnType>
  892. </ReturnValue>
  893. <Docs>
  894. <value>To be added.</value>
  895. <remarks>To be added.</remarks>
  896. <summary>
  897. <attribution license="cc4" from="Microsoft" modified="false" />
  898. <para>Gets or sets the behavior of the command used to fill the data adapter.</para>
  899. </summary>
  900. </Docs>
  901. </Member>
  902. <Member MemberName="FillError">
  903. <MemberSignature Language="C#" Value="public event System.Data.FillErrorEventHandler FillError;" />
  904. <MemberType>Event</MemberType>
  905. <ReturnValue>
  906. <ReturnType>System.Data.FillErrorEventHandler</ReturnType>
  907. </ReturnValue>
  908. <Parameters />
  909. <Docs>
  910. <summary>To be added</summary>
  911. <remarks>To be added</remarks>
  912. </Docs>
  913. <AssemblyInfo>
  914. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  915. </AssemblyInfo>
  916. <Attributes>
  917. <Attribute>
  918. <AttributeName>System.Data.DataSysDescription(Description="Event triggered when a recoverable error occurs during Fill.")</AttributeName>
  919. </Attribute>
  920. </Attributes>
  921. </Member>
  922. <Member MemberName="FillSchema">
  923. <MemberSignature Language="C#" Value="public override System.Data.DataTable[] FillSchema (System.Data.DataSet dataSet, System.Data.SchemaType schemaType);" />
  924. <MemberType>Method</MemberType>
  925. <ReturnValue>
  926. <ReturnType>System.Data.DataTable[]</ReturnType>
  927. </ReturnValue>
  928. <Parameters>
  929. <Parameter Name="dataSet" Type="System.Data.DataSet" />
  930. <Parameter Name="schemaType" Type="System.Data.SchemaType" />
  931. </Parameters>
  932. <Docs>
  933. <remarks>
  934. <attribution license="cc4" from="Microsoft" modified="false" />
  935. <para>This method retrieves the schema information from the data source using the <see cref="P:System.Data.IDbDataAdapter.SelectCommand" />.</para>
  936. <para>A <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> operation adds a <see cref="T:System.Data.DataTable" /> to the destination <see cref="T:System.Data.DataSet" />. It then adds columns to the <see cref="T:System.Data.DataColumnCollection" /> of the <see cref="T:System.Data.DataTable" />, and configures the following <see cref="T:System.Data.DataColumn" /> properties if they exist at the data source: </para>
  937. <list type="bullet">
  938. <item>
  939. <para>
  940. <see cref="P:System.Data.DataColumn.AllowDBNull" /> </para>
  941. </item>
  942. <item>
  943. <para>
  944. <see cref="P:System.Data.DataColumn.AutoIncrement" />. You must set <see cref="P:System.Data.DataColumn.AutoIncrementStep" /> and <see cref="P:System.Data.DataColumn.AutoIncrementSeed" /> separately.</para>
  945. </item>
  946. <item>
  947. <para>
  948. <see cref="P:System.Data.DataColumn.MaxLength" /> </para>
  949. </item>
  950. <item>
  951. <para>
  952. <see cref="P:System.Data.DataColumn.ReadOnly" /> </para>
  953. </item>
  954. <item>
  955. <para>
  956. <see cref="P:System.Data.DataColumn.Unique" /> </para>
  957. </item>
  958. </list>
  959. <para>
  960. <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> also configures the <see cref="P:System.Data.DataTable.PrimaryKey" /> and <see cref="P:System.Data.DataTable.Constraints" /> properties according to the following rules: </para>
  961. <list type="bullet">
  962. <item>
  963. <para>If one or more primary key columns are returned by the <see cref="P:System.Data.IDbDataAdapter.SelectCommand" />, they are used as the primary key columns for the <see cref="T:System.Data.DataTable" />.</para>
  964. </item>
  965. <item>
  966. <para>If no primary key columns are returned but unique columns are, the unique columns are used as the primary key if, and only if, all the unique columns are nonnullable. If any of the columns are nullable, a <see cref="T:System.Data.UniqueConstraint" /> is added to the <see cref="T:System.Data.ConstraintCollection" />, but the <see cref="P:System.Data.DataTable.PrimaryKey" /> property is not set.</para>
  967. </item>
  968. <item>
  969. <para>If both primary key columns and unique columns are returned, the primary key columns are used as the primary key columns for the <see cref="T:System.Data.DataTable" />.</para>
  970. </item>
  971. </list>
  972. <para>Note that primary keys and unique constraints are added to the <see cref="T:System.Data.ConstraintCollection" /> according to the preceding rules, but other constraint types are not added.</para>
  973. <para>If a unique clustered index is defined on a column or columns in a SQL Server table and the primary key constraint is defined on a separate set of columns, then the names of the columns in the clustered index will be returned. To return the name or names of the primary key columns, use a query hint with the SELECT statement that specifies the name of the primary key index. For more information about specifying query hints, see <see cref="http://msdn.microsoft.com/library/ms181714.aspx">Query Hint (Transact-SQL)</see>.</para>
  974. <para>Primary key information is used during <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> to find and replace any rows whose key columns match. If this is not the desired behavior, use <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> without requesting schema information.</para>
  975. <para>If the <see cref="T:System.Data.IDataAdapter" /> encounters duplicate columns while populating a <see cref="T:System.Data.DataTable" />, it generates names for the subsequent columns, using the pattern "columnname1", "columnname2", "columnname3", and so on. If the incoming data contains unnamed columns, they are placed in the <see cref="T:System.Data.DataSet" /> according to the pattern "Column1", "Column2", and so on. When multiple result sets are added to the <see cref="T:System.Data.DataSet" /> each result set is placed in a separate table. Additional result sets are named by appending integral values to the specified table name (for example, "Table", "Table1", "Table2", and so on.). Applications using column and table names should ensure that conflicts with these naming patterns does not occur.</para>
  976. <para>The <see cref="T:System.Data.IDbConnection" /> object associated with the select command must be valid, but it does not need to open. If the <see cref="T:System.Data.IDbConnection" /> is closed before <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> is called, it is opened to retrieve data, then closed. If the connection is open before <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> is called, it is left open.</para>
  977. <block subset="none" type="note">
  978. <para>When handling batch SQL statements that return multiple results, the implementation of <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> for the .NET Framework Data Provider for OLE DB retrieves schema information for only the first result. To retrieve schema information for multiple results, use <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> with the <see cref="T:System.Data.MissingSchemaAction" /> set to AddWithKey.</para>
  979. </block>
  980. <para>When using <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" />, the .NET Framework Data Provider for SQL Server appends a FOR BROWSE clause to the statement being executed. The user should be aware of potential side effects, such as interference with the use of SET FMTONLY ON statements. See SQL Server Books Online for more information.</para>
  981. </remarks>
  982. <summary>
  983. <attribution license="cc4" from="Microsoft" modified="false" />
  984. <para>Adds a <see cref="T:System.Data.DataTable" /> named "Table" to the specified <see cref="T:System.Data.DataSet" /> and configures the schema to match that in the data source based on the specified <see cref="T:System.Data.SchemaType" />.</para>
  985. </summary>
  986. <returns>
  987. <attribution license="cc4" from="Microsoft" modified="false" />
  988. <para>A reference to a collection of <see cref="T:System.Data.DataTable" /> objects that were added to the <see cref="T:System.Data.DataSet" />.</para>
  989. </returns>
  990. <param name="dataSet">
  991. <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Data.DataSet" /> to insert the schema in. </param>
  992. <param name="schemaType">
  993. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.SchemaType" /> values that specify how to insert the schema. </param>
  994. </Docs>
  995. <AssemblyInfo>
  996. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  997. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  998. </AssemblyInfo>
  999. </Member>
  1000. <Member MemberName="FillSchema">
  1001. <MemberSignature Language="C#" Value="public System.Data.DataTable FillSchema (System.Data.DataTable dataTable, System.Data.SchemaType schemaType);" />
  1002. <MemberType>Method</MemberType>
  1003. <ReturnValue>
  1004. <ReturnType>System.Data.DataTable</ReturnType>
  1005. </ReturnValue>
  1006. <Parameters>
  1007. <Parameter Name="dataTable" Type="System.Data.DataTable" />
  1008. <Parameter Name="schemaType" Type="System.Data.SchemaType" />
  1009. </Parameters>
  1010. <Docs>
  1011. <remarks>
  1012. <attribution license="cc4" from="Microsoft" modified="false" />
  1013. <para>The <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> method retrieves the schema from the data source using the <see cref="P:System.Data.IDbDataAdapter.SelectCommand" />. The connection object associated with the <see cref="P:System.Data.IDbDataAdapter.SelectCommand" /> must be valid, but it does not need to be open. If the connection is closed before <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> is called, it is opened to retrieve data, then closed. If the connection is open before <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> is called, it remains open.</para>
  1014. <para>A <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> operation returns a <see cref="T:System.Data.DataTable" />. It then adds columns to the <see cref="T:System.Data.DataColumnCollection" /> of the <see cref="T:System.Data.DataTable" />, and configures the following <see cref="T:System.Data.DataColumn" /> properties if they exist at the data source: </para>
  1015. <list type="bullet">
  1016. <item>
  1017. <para>
  1018. <see cref="P:System.Data.DataColumn.AllowDBNull" /> </para>
  1019. </item>
  1020. <item>
  1021. <para>
  1022. <see cref="P:System.Data.DataColumn.AutoIncrement" />. You must set <see cref="P:System.Data.DataColumn.AutoIncrementStep" /> and <see cref="P:System.Data.DataColumn.AutoIncrementSeed" /> separately.</para>
  1023. </item>
  1024. <item>
  1025. <para>
  1026. <see cref="P:System.Data.DataColumn.MaxLength" /> </para>
  1027. </item>
  1028. <item>
  1029. <para>
  1030. <see cref="P:System.Data.DataColumn.ReadOnly" /> </para>
  1031. </item>
  1032. <item>
  1033. <para>
  1034. <see cref="P:System.Data.DataColumn.Unique" /> </para>
  1035. </item>
  1036. </list>
  1037. <para>
  1038. <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> also configures the <see cref="P:System.Data.DataTable.PrimaryKey" /> and <see cref="P:System.Data.DataTable.Constraints" /> properties according to the following rules: </para>
  1039. <list type="bullet">
  1040. <item>
  1041. <para>If a <see cref="P:System.Data.DataTable.PrimaryKey" /> has already been defined for the DataTable, or the DataTable contains data, the PrimaryKey property will not be set.</para>
  1042. </item>
  1043. <item>
  1044. <para>If one or more primary key columns are returned by the <see cref="P:System.Data.IDbDataAdapter.SelectCommand" />, they are used as the primary key columns for the DataTable.</para>
  1045. </item>
  1046. <item>
  1047. <para>If no primary key columns are returned but unique columns are, the unique columns are used as the primary key if, and only if, all the unique columns are nonnullable. If any of the columns are nullable, a <see cref="T:System.Data.UniqueConstraint" /> is added to the <see cref="T:System.Data.ConstraintCollection" />, but the PrimaryKey property is not set.</para>
  1048. </item>
  1049. <item>
  1050. <para>If both primary key columns and unique columns are returned, the primary key columns are used as the primary key columns for the DataTable.</para>
  1051. </item>
  1052. </list>
  1053. <para>Note that primary keys and unique constraints are added to the <see cref="T:System.Data.ConstraintCollection" /> according to the preceding rules, but other constraint types are not added. This process may require several round-trips to the server.</para>
  1054. <para>If a unique clustered index is defined on a column or columns in a SQL Server table and the primary key constraint is defined on a separate set of columns, then the names of the columns in the clustered index will be returned. To return the name or names of the primary key columns, use a query hint with the SELECT statement that specifies the name of the primary key index. For more information about specifying query hints, see <see cref="http://msdn.microsoft.com/library/ms181714.aspx">Query Hint (Transact-SQL)</see>.</para>
  1055. <para>If the <see cref="T:System.Data.Common.DbDataAdapter" /> encounters duplicate columns while populating a <see cref="T:System.Data.DataTable" />, it generates names for the subsequent columns, using the pattern "columnname1", "columnname2", "columnname3", and so on. If the incoming data contains unnamed columns, they are placed in the <see cref="T:System.Data.DataSet" /> according to the pattern "Column1", "Column2", and so on. When multiple result sets are added to the <see cref="T:System.Data.DataSet" /> each result set is placed in a separate table. Additional result sets are named by appending integral values to the specified table name (for example, "Table", "Table1", "Table2", and so on.). Applications using column and table names should ensure that conflicts with these naming patterns does not occur.</para>
  1056. <para>
  1057. <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> does not return any rows. Use the <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method to add rows to a <see cref="T:System.Data.DataTable" />.</para>
  1058. <block subset="none" type="note">
  1059. <para>When handling batch SQL statements that return multiple results, the implementation of <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> for the .NET Framework Data Provider for OLE DB retrieves schema information for only the first result. To retrieve schema information for multiple results, use <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> with the <see cref="T:System.Data.MissingSchemaAction" /> set to AddWithKey.</para>
  1060. </block>
  1061. <para>When using <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" />, the .NET Framework Data Provider for SQL Server appends a FOR BROWSE clause to the statement being executed. The user should be aware of potential side effects, such as interference with the use of SET FMTONLY ON statements. See SQL Server Books Online for more information.</para>
  1062. </remarks>
  1063. <summary>
  1064. <attribution license="cc4" from="Microsoft" modified="false" />
  1065. <para>Configures the schema of the specified <see cref="T:System.Data.DataTable" /> based on the specified <see cref="T:System.Data.SchemaType" />.</para>
  1066. </summary>
  1067. <returns>
  1068. <attribution license="cc4" from="Microsoft" modified="false" />
  1069. <para>A <see cref="T:System.Data.DataTable" /> that contains schema information returned from the data source.</para>
  1070. </returns>
  1071. <param name="dataTable">
  1072. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.DataTable" /> to be filled with the schema from the data source. </param>
  1073. <param name="schemaType">
  1074. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.SchemaType" /> values. </param>
  1075. </Docs>
  1076. <AssemblyInfo>
  1077. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  1078. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1079. </AssemblyInfo>
  1080. </Member>
  1081. <Member MemberName="FillSchema">
  1082. <MemberSignature Language="C#" Value="public System.Data.DataTable[] FillSchema (System.Data.DataSet dataSet, System.Data.SchemaType schemaType, string srcTable);" />
  1083. <MemberType>Method</MemberType>
  1084. <ReturnValue>
  1085. <ReturnType>System.Data.DataTable[]</ReturnType>
  1086. </ReturnValue>
  1087. <Parameters>
  1088. <Parameter Name="dataSet" Type="System.Data.DataSet" />
  1089. <Parameter Name="schemaType" Type="System.Data.SchemaType" />
  1090. <Parameter Name="srcTable" Type="System.String" />
  1091. </Parameters>
  1092. <Docs>
  1093. <remarks>
  1094. <attribution license="cc4" from="Microsoft" modified="false" />
  1095. <para>This method retrieves the schema information from the data source using the <see cref="P:System.Data.IDbDataAdapter.SelectCommand" />.</para>
  1096. <para>A <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> operation adds a <see cref="T:System.Data.DataTable" /> to the destination <see cref="T:System.Data.DataSet" />. It then adds columns to the <see cref="T:System.Data.DataColumnCollection" /> of the <see cref="T:System.Data.DataTable" />, and configures the following <see cref="T:System.Data.DataColumn" /> properties if they exist at the data source: </para>
  1097. <list type="bullet">
  1098. <item>
  1099. <para>
  1100. <see cref="P:System.Data.DataColumn.AllowDBNull" /> </para>
  1101. </item>
  1102. <item>
  1103. <para>
  1104. <see cref="P:System.Data.DataColumn.AutoIncrement" />. You must set <see cref="P:System.Data.DataColumn.AutoIncrementStep" /> and <see cref="P:System.Data.DataColumn.AutoIncrementSeed" /> separately.</para>
  1105. </item>
  1106. <item>
  1107. <para>
  1108. <see cref="P:System.Data.DataColumn.MaxLength" /> </para>
  1109. </item>
  1110. <item>
  1111. <para>
  1112. <see cref="P:System.Data.DataColumn.ReadOnly" /> </para>
  1113. </item>
  1114. <item>
  1115. <para>
  1116. <see cref="P:System.Data.DataColumn.Unique" /> </para>
  1117. </item>
  1118. </list>
  1119. <para>
  1120. <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> also configures the <see cref="P:System.Data.DataTable.PrimaryKey" /> and <see cref="P:System.Data.DataTable.Constraints" /> properties according to the following rules: </para>
  1121. <list type="bullet">
  1122. <item>
  1123. <para>If one or more primary key columns are returned by the <see cref="P:System.Data.IDbDataAdapter.SelectCommand" />, they are used as the primary key columns for the <see cref="T:System.Data.DataTable" />.</para>
  1124. </item>
  1125. <item>
  1126. <para>If no primary key columns are returned but unique columns are, the unique columns are used as the primary key if, and only if, all the unique columns are nonnullable. If any of the columns are nullable, a <see cref="T:System.Data.UniqueConstraint" /> is added to the <see cref="T:System.Data.ConstraintCollection" />, but the <see cref="P:System.Data.DataTable.PrimaryKey" /> property is not set.</para>
  1127. </item>
  1128. <item>
  1129. <para>If both primary key columns and unique columns are returned, the primary key columns are used as the primary key columns for the <see cref="T:System.Data.DataTable" />.</para>
  1130. </item>
  1131. </list>
  1132. <para>Note that primary keys and unique constraints are added to the <see cref="T:System.Data.ConstraintCollection" /> according to the preceding rules, but other constraint types are not added.</para>
  1133. <para>If a unique clustered index is defined on a column or columns in a SQL Server table and the primary key constraint is defined on a separate set of columns, then the names of the columns in the clustered index will be returned. To return the name or names of the primary key columns, use a query hint with the SELECT statement that specifies the name of the primary key index. For more information about specifying query hints, see <see cref="http://msdn.microsoft.com/library/ms181714.aspx">Query Hint (Transact-SQL)</see>.</para>
  1134. <para>Primary key information is used during <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> to find and replace any rows whose key columns match. If this is not the desired behavior, use <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> without requesting schema information.</para>
  1135. <para>If the <see cref="T:System.Data.Common.DbDataAdapter" /> encounters duplicate columns while populating a <see cref="T:System.Data.DataTable" />, it generates names for the subsequent columns, using the pattern "columnname1", "columnname2", "columnname3", and so on. If the incoming data contains unnamed columns, they are placed in the <see cref="T:System.Data.DataSet" /> according to the pattern "Column1", "Column2", and so on. When multiple result sets are added to the <see cref="T:System.Data.DataSet" /> each result set is placed in a separate table. Additional result sets are named by appending integral values to the specified table name (for example, "Table", "Table1", "Table2", and so on.). Applications using column and table names should ensure that conflicts with these naming patterns does not occur.</para>
  1136. <para>The <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> method supports scenarios where the <see cref="T:System.Data.DataSet" /> contains multiple <see cref="T:System.Data.DataTable" /> objects whose names differ only by case. In such situations, <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> performs a case-sensitive comparison to find the corresponding table, and creates a new table if no exact match exists. The following C# code illustrates this behavior.</para>
  1137. <code> DataSet dataset = new DataSet();
  1138. dataset.Tables.Add("aaa");
  1139. dataset.Tables.Add("AAA");
  1140. adapter.FillSchema(dataset, "aaa"); // Fills the schema of "aaa", which already exists in the DataSet.
  1141. adapter.FillSchema(dataset, "Aaa"); // Adds a new table called "Aaa".</code>
  1142. <para>If <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> is called and the <see cref="T:System.Data.DataSet" /> contains only one <see cref="T:System.Data.DataTable" /> whose name differs only by case, that <see cref="T:System.Data.DataTable" /> is updated. In this scenario, the comparison is case insensitive. The following C# code illustrates this behavior.</para>
  1143. <code> DataSet dataset = new DataSet();
  1144. dataset.Tables.Add("aaa");
  1145. adapter.FillSchema(dataset, "AAA"); // Fills the schema of table "aaa" because only one similarly named table is in the DataSet.</code>
  1146. <para>The <see cref="T:System.Data.IDbConnection" /> object associated with the select command must be valid, but it does not need to open. If the <see cref="T:System.Data.IDbConnection" /> is closed before <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> is called, it is opened to retrieve data, then closed. If the connection is open before <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> is called, it is left open.</para>
  1147. <block subset="none" type="note">
  1148. <para>When handling batch SQL statements that return multiple results, the implementation of <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> for the .NET Framework Data Provider for OLE DB retrieves schema information for only the first result. To retrieve schema information for multiple results, use <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> with the <see cref="T:System.Data.MissingSchemaAction" /> set to AddWithKey.</para>
  1149. </block>
  1150. <para>When using <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" />, the .NET Framework Data Provider for SQL Server appends a FOR BROWSE clause to the statement being executed. The user should be aware of potential side effects, such as interference with the use of SET FMTONLY ON statements. See SQL Server Books Online for more information.</para>
  1151. </remarks>
  1152. <summary>
  1153. <attribution license="cc4" from="Microsoft" modified="false" />
  1154. <para>Adds a <see cref="T:System.Data.DataTable" /> to the specified <see cref="T:System.Data.DataSet" /> and configures the schema to match that in the data source based upon the specified <see cref="T:System.Data.SchemaType" /> and <see cref="T:System.Data.DataTable" />.</para>
  1155. </summary>
  1156. <returns>
  1157. <attribution license="cc4" from="Microsoft" modified="false" />
  1158. <para>A reference to a collection of <see cref="T:System.Data.DataTable" /> objects that were added to the <see cref="T:System.Data.DataSet" />.</para>
  1159. </returns>
  1160. <param name="dataSet">
  1161. <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Data.DataSet" /> to insert the schema in. </param>
  1162. <param name="schemaType">
  1163. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.SchemaType" /> values that specify how to insert the schema. </param>
  1164. <param name="srcTable">
  1165. <attribution license="cc4" from="Microsoft" modified="false" />The name of the source table to use for table mapping. </param>
  1166. </Docs>
  1167. <AssemblyInfo>
  1168. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  1169. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1170. </AssemblyInfo>
  1171. </Member>
  1172. <Member MemberName="FillSchema">
  1173. <MemberSignature Language="C#" Value="protected virtual System.Data.DataTable FillSchema (System.Data.DataTable dataTable, System.Data.SchemaType schemaType, System.Data.IDbCommand command, System.Data.CommandBehavior behavior);" />
  1174. <MemberType>Method</MemberType>
  1175. <ReturnValue>
  1176. <ReturnType>System.Data.DataTable</ReturnType>
  1177. </ReturnValue>
  1178. <Parameters>
  1179. <Parameter Name="dataTable" Type="System.Data.DataTable" />
  1180. <Parameter Name="schemaType" Type="System.Data.SchemaType" />
  1181. <Parameter Name="command" Type="System.Data.IDbCommand" />
  1182. <Parameter Name="behavior" Type="System.Data.CommandBehavior" />
  1183. </Parameters>
  1184. <Docs>
  1185. <remarks>
  1186. <attribution license="cc4" from="Microsoft" modified="false" />
  1187. <para>The <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> method retrieves the schema from the data source using the <see cref="P:System.Data.IDbDataAdapter.SelectCommand" />. The connection object associated with the <see cref="P:System.Data.IDbDataAdapter.SelectCommand" /> must be valid, but it does not need to be open. If the connection is closed before <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> is called, it is opened to retrieve data, then closed. If the connection is open before <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> is called, it remains open.</para>
  1188. <para>A <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> operation adds a <see cref="T:System.Data.DataTable" /> to the destination <see cref="T:System.Data.DataSet" />. It then adds columns to the <see cref="T:System.Data.DataColumnCollection" /> of the <see cref="T:System.Data.DataTable" />, and configures the following <see cref="T:System.Data.DataColumn" /> properties if they exist at the data source: </para>
  1189. <list type="bullet">
  1190. <item>
  1191. <para>
  1192. <see cref="P:System.Data.DataColumn.AllowDBNull" /> </para>
  1193. </item>
  1194. <item>
  1195. <para>
  1196. <see cref="P:System.Data.DataColumn.AutoIncrement" />. You must set <see cref="P:System.Data.DataColumn.AutoIncrementStep" /> and <see cref="P:System.Data.DataColumn.AutoIncrementSeed" /> separately.</para>
  1197. </item>
  1198. <item>
  1199. <para>
  1200. <see cref="P:System.Data.DataColumn.MaxLength" /> </para>
  1201. </item>
  1202. <item>
  1203. <para>
  1204. <see cref="P:System.Data.DataColumn.ReadOnly" /> </para>
  1205. </item>
  1206. <item>
  1207. <para>
  1208. <see cref="P:System.Data.DataColumn.Unique" /> </para>
  1209. </item>
  1210. </list>
  1211. <para>
  1212. <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> also configures the <see cref="P:System.Data.DataTable.PrimaryKey" /> and <see cref="P:System.Data.DataTable.Constraints" /> properties according to the following rules: </para>
  1213. <list type="bullet">
  1214. <item>
  1215. <para>If one or more primary key columns are returned by the <see cref="P:System.Data.IDbDataAdapter.SelectCommand" />, they are used as the primary key columns for the <see cref="T:System.Data.DataTable" />.</para>
  1216. </item>
  1217. <item>
  1218. <para>If no primary key columns are returned but unique columns are, the unique columns are used as the primary key if, and only if, all the unique columns are nonnullable. If any of the columns are nullable, a <see cref="T:System.Data.UniqueConstraint" /> is added to the <see cref="T:System.Data.ConstraintCollection" />, but the <see cref="P:System.Data.DataTable.PrimaryKey" /> property is not set.</para>
  1219. </item>
  1220. <item>
  1221. <para>If both primary key columns and unique columns are returned, the primary key columns are used as the primary key columns for the <see cref="T:System.Data.DataTable" />.</para>
  1222. </item>
  1223. </list>
  1224. <para>Note that primary keys and unique constraints are added to the <see cref="T:System.Data.ConstraintCollection" /> according to the preceding rules, but other constraint types are not added.</para>
  1225. <para>If a unique clustered index is defined on a column or columns in a SQL Server table and the primary key constraint is defined on a separate set of columns, then the names of the columns in the clustered index will be returned. To return the name or names of the primary key columns, use a query hint with the SELECT statement that specifies the name of the primary key index. For more information about specifying query hints, see <see cref="http://msdn.microsoft.com/library/ms181714.aspx">Query Hint (Transact-SQL)</see>.</para>
  1226. <para>If the <see cref="T:System.Data.IDataAdapter" /> encounters duplicate columns while populating a <see cref="T:System.Data.DataTable" />, it generates names for the subsequent columns, using the pattern "columnname1", "columnname2", "columnname3", and so on. If the incoming data contains unnamed columns, they are placed in the <see cref="T:System.Data.DataSet" /> according to the pattern "Column1", "Column2", and so on. When multiple result sets are added to the <see cref="T:System.Data.DataSet" /> each result set is placed in a separate table. Additional result sets are named by appending integral values to the specified table name (for example, "Table", "Table1", "Table2", and so on.). Applications using column and table names should ensure that conflicts with these naming patterns does not occur.</para>
  1227. <para>
  1228. <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> does not return any rows. Use the <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method to add rows to a <see cref="T:System.Data.DataTable" />.</para>
  1229. <block subset="none" type="note">
  1230. <para>When handling batch SQL statements that return multiple results, the implementation of <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> for the .NET Framework Data Provider for OLE DB retrieves schema information for only the first result. To retrieve schema information for multiple results, use <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> with the <see cref="T:System.Data.MissingSchemaAction" /> set to AddWithKey.</para>
  1231. </block>
  1232. <para>When using <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" />, the .NET Framework Data Provider for SQL Server appends a FOR BROWSE clause to the statement being executed. The user should be aware of potential side effects, such as interference with the use of SET FMTONLY ON statements. See SQL Server Books Online for more information.</para>
  1233. </remarks>
  1234. <summary>
  1235. <attribution license="cc4" from="Microsoft" modified="false" />
  1236. <para>Configures the schema of the specified <see cref="T:System.Data.DataTable" /> based on the specified <see cref="T:System.Data.SchemaType" />, command string, and <see cref="T:System.Data.CommandBehavior" /> values.</para>
  1237. </summary>
  1238. <returns>
  1239. <attribution license="cc4" from="Microsoft" modified="false" />
  1240. <para>A of <see cref="T:System.Data.DataTable" /> object that contains schema information returned from the data source.</para>
  1241. </returns>
  1242. <param name="dataTable">
  1243. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.DataTable" /> to be filled with the schema from the data source. </param>
  1244. <param name="schemaType">
  1245. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.SchemaType" /> values. </param>
  1246. <param name="command">
  1247. <attribution license="cc4" from="Microsoft" modified="false" />The SQL SELECT statement used to retrieve rows from the data source. </param>
  1248. <param name="behavior">
  1249. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.CommandBehavior" /> values. </param>
  1250. </Docs>
  1251. <AssemblyInfo>
  1252. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  1253. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1254. </AssemblyInfo>
  1255. </Member>
  1256. <Member MemberName="FillSchema">
  1257. <MemberSignature Language="C#" Value="protected virtual System.Data.DataTable[] FillSchema (System.Data.DataSet dataSet, System.Data.SchemaType schemaType, System.Data.IDbCommand command, string srcTable, System.Data.CommandBehavior behavior);" />
  1258. <MemberType>Method</MemberType>
  1259. <ReturnValue>
  1260. <ReturnType>System.Data.DataTable[]</ReturnType>
  1261. </ReturnValue>
  1262. <Parameters>
  1263. <Parameter Name="dataSet" Type="System.Data.DataSet" />
  1264. <Parameter Name="schemaType" Type="System.Data.SchemaType" />
  1265. <Parameter Name="command" Type="System.Data.IDbCommand" />
  1266. <Parameter Name="srcTable" Type="System.String" />
  1267. <Parameter Name="behavior" Type="System.Data.CommandBehavior" />
  1268. </Parameters>
  1269. <Docs>
  1270. <remarks>
  1271. <attribution license="cc4" from="Microsoft" modified="false" />
  1272. <para>The <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> method retrieves the schema from the data source using the <see cref="P:System.Data.IDbDataAdapter.SelectCommand" />. The connection object associated with the <see cref="P:System.Data.IDbDataAdapter.SelectCommand" /> must be valid, but it does not need to be open. If the connection is closed before <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> is called, it is opened to retrieve data, then closed. If the connection is open before <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> is called, it remains open.</para>
  1273. <para>A <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> operation adds a <see cref="T:System.Data.DataTable" /> to the destination <see cref="T:System.Data.DataSet" />. It then adds columns to the <see cref="T:System.Data.DataColumnCollection" /> of the <see cref="T:System.Data.DataTable" />, and configures the following <see cref="T:System.Data.DataColumn" /> properties if they exist at the data source: </para>
  1274. <list type="bullet">
  1275. <item>
  1276. <para>
  1277. <see cref="P:System.Data.DataColumn.AllowDBNull" /> </para>
  1278. </item>
  1279. <item>
  1280. <para>
  1281. <see cref="P:System.Data.DataColumn.AutoIncrement" />. You must set <see cref="P:System.Data.DataColumn.AutoIncrementStep" /> and <see cref="P:System.Data.DataColumn.AutoIncrementSeed" /> separately.</para>
  1282. </item>
  1283. <item>
  1284. <para>
  1285. <see cref="P:System.Data.DataColumn.MaxLength" /> </para>
  1286. </item>
  1287. <item>
  1288. <para>
  1289. <see cref="P:System.Data.DataColumn.ReadOnly" /> </para>
  1290. </item>
  1291. <item>
  1292. <para>
  1293. <see cref="P:System.Data.DataColumn.Unique" /> </para>
  1294. </item>
  1295. </list>
  1296. <para>
  1297. <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> also configures the <see cref="P:System.Data.DataTable.PrimaryKey" /> and <see cref="P:System.Data.DataTable.Constraints" /> properties according to the following rules: </para>
  1298. <list type="bullet">
  1299. <item>
  1300. <para>If one or more primary key columns are returned by the <see cref="P:System.Data.IDbDataAdapter.SelectCommand" />, they are used as the primary key columns for the <see cref="T:System.Data.DataTable" />.</para>
  1301. </item>
  1302. <item>
  1303. <para>If no primary key columns are returned but unique columns are, the unique columns are used as the primary key if, and only if, all the unique columns are nonnullable. If any of the columns are nullable, a <see cref="T:System.Data.UniqueConstraint" /> is added to the <see cref="T:System.Data.ConstraintCollection" />, but the <see cref="P:System.Data.DataTable.PrimaryKey" /> property is not set.</para>
  1304. </item>
  1305. <item>
  1306. <para>If both primary key columns and unique columns are returned, the primary key columns are used as the primary key columns for the <see cref="T:System.Data.DataTable" />.</para>
  1307. </item>
  1308. </list>
  1309. <para>Note that primary keys and unique constraints are added to the <see cref="T:System.Data.ConstraintCollection" /> according to the preceding rules, but other constraint types are not added.</para>
  1310. <para>If a unique clustered index is defined on a column or columns in a SQL Server table and the primary key constraint is defined on a separate set of columns, then the names of the columns in the clustered index will be returned. To return the name or names of the primary key columns, use a query hint with the SELECT statement that specifies the name of the primary key index. For more information about specifying query hints, see <see cref="http://msdn.microsoft.com/library/ms181714.aspx">Query Hint (Transact-SQL)</see>.</para>
  1311. <para>If the <see cref="T:System.Data.IDataAdapter" /> encounters duplicate columns while populating a <see cref="T:System.Data.DataTable" />, it generates names for the subsequent columns, using the pattern "columnname1", "columnname2", "columnname3", and so on. If the incoming data contains unnamed columns, they are placed in the <see cref="T:System.Data.DataSet" /> according to the pattern "Column1", "Column2", and so on. When multiple result sets are added to the <see cref="T:System.Data.DataSet" /> each result set is placed in a separate table. Additional result sets are named by appending integral values to the specified table name (for example, "Table", "Table1", "Table2", and so on.). Applications using column and table names should ensure that conflicts with these naming patterns does not occur.</para>
  1312. <para>The <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> method supports scenarios where the <see cref="T:System.Data.DataSet" /> contains multiple <see cref="T:System.Data.DataTable" /> objects whose names differ only by case. In such situations, <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> performs a case-sensitive comparison to find the corresponding table, and creates a new table if no exact match exists. The following C# code illustrates this behavior.</para>
  1313. <code> DataSet dataset = new DataSet();
  1314. dataset.Tables.Add("aaa");
  1315. dataset.Tables.Add("AAA");
  1316. adapter.FillSchema(dataset, "aaa"); // Fills the schema of "aaa", which already exists in the DataSet.
  1317. adapter.FillSchema(dataset, "Aaa"); // Adds a new table called "Aaa".</code>
  1318. <para>If <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> is called and the <see cref="T:System.Data.DataSet" /> contains only one <see cref="T:System.Data.DataTable" /> whose name differs only by case, that <see cref="T:System.Data.DataTable" /> is updated. In this scenario, the comparison is case insensitive. The following C# code illustrates this behavior.</para>
  1319. <code> DataSet dataset = new DataSet();
  1320. dataset.Tables.Add("aaa");
  1321. adapter.FillSchema(dataset, "AAA"); // Fills the schema of table "aaa" because only one similarly named table is in the DataSet.</code>
  1322. <para>
  1323. <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> does not return any rows. Use the <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> method to add rows to a <see cref="T:System.Data.DataTable" />.</para>
  1324. <block subset="none" type="note">
  1325. <para>When handling batch SQL statements that return multiple results, the implementation of <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" /> for the .NET Framework Data Provider for OLE DB retrieves schema information for only the first result. To retrieve schema information for multiple results, use <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> with the <see cref="T:System.Data.MissingSchemaAction" /> set to AddWithKey.</para>
  1326. </block>
  1327. <para>When using <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" />, the .NET Framework Data Provider for SQL Server appends a FOR BROWSE clause to the statement being executed. The user should be aware of potential side effects, such as interference with the use of SET FMTONLY ON statements. See SQL Server Books Online for more information.</para>
  1328. </remarks>
  1329. <summary>
  1330. <attribution license="cc4" from="Microsoft" modified="false" />
  1331. <para>Adds a <see cref="T:System.Data.DataTable" /> to the specified <see cref="T:System.Data.DataSet" /> and configures the schema to match that in the data source based on the specified <see cref="T:System.Data.SchemaType" />.</para>
  1332. </summary>
  1333. <returns>
  1334. <attribution license="cc4" from="Microsoft" modified="false" />
  1335. <para>An array of <see cref="T:System.Data.DataTable" /> objects that contain schema information returned from the data source.</para>
  1336. </returns>
  1337. <param name="dataSet">
  1338. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.DataSet" /> to be filled with the schema from the data source. </param>
  1339. <param name="schemaType">
  1340. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.SchemaType" /> values. </param>
  1341. <param name="command">
  1342. <attribution license="cc4" from="Microsoft" modified="false" />The SQL SELECT statement used to retrieve rows from the data source. </param>
  1343. <param name="srcTable">
  1344. <attribution license="cc4" from="Microsoft" modified="false" />The name of the source table to use for table mapping. </param>
  1345. <param name="behavior">
  1346. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.CommandBehavior" /> values. </param>
  1347. </Docs>
  1348. <AssemblyInfo>
  1349. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  1350. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1351. </AssemblyInfo>
  1352. </Member>
  1353. <Member MemberName="GetBatchedParameter">
  1354. <MemberSignature Language="C#" Value="protected virtual System.Data.IDataParameter GetBatchedParameter (int commandIdentifier, int parameterIndex);" />
  1355. <MemberType>Method</MemberType>
  1356. <AssemblyInfo>
  1357. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1358. </AssemblyInfo>
  1359. <ReturnValue>
  1360. <ReturnType>System.Data.IDataParameter</ReturnType>
  1361. </ReturnValue>
  1362. <Parameters>
  1363. <Parameter Name="commandIdentifier" Type="System.Int32" />
  1364. <Parameter Name="parameterIndex" Type="System.Int32" />
  1365. </Parameters>
  1366. <Docs>
  1367. <remarks>
  1368. <attribution license="cc4" from="Microsoft" modified="false" />
  1369. <para>In <see cref="T:System.Data.Common.DbDataAdapter" />, this method throws <see cref="T:System.NotSupportedException" />. Classes that inherit from <see cref="T:System.Data.Common.DbDataAdapter" /> override this method to provide support for batches.</para>
  1370. </remarks>
  1371. <summary>
  1372. <attribution license="cc4" from="Microsoft" modified="false" />
  1373. <para>Returns a <see cref="T:System.Data.IDataParameter" /> from one of the commands in the current batch.</para>
  1374. </summary>
  1375. <returns>
  1376. <attribution license="cc4" from="Microsoft" modified="false" />
  1377. <para>The <see cref="T:System.Data.IDataParameter" /> specified.</para>
  1378. </returns>
  1379. <param name="commandIdentifier">
  1380. <attribution license="cc4" from="Microsoft" modified="false" />The index of the command to retrieve the parameter from.</param>
  1381. <param name="parameterIndex">
  1382. <attribution license="cc4" from="Microsoft" modified="false" />The index of the parameter within the command.</param>
  1383. </Docs>
  1384. </Member>
  1385. <Member MemberName="GetBatchedRecordsAffected">
  1386. <MemberSignature Language="C#" Value="protected virtual bool GetBatchedRecordsAffected (int commandIdentifier, out int recordsAffected, out Exception error);" />
  1387. <MemberType>Method</MemberType>
  1388. <AssemblyInfo>
  1389. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1390. </AssemblyInfo>
  1391. <ReturnValue>
  1392. <ReturnType>System.Boolean</ReturnType>
  1393. </ReturnValue>
  1394. <Parameters>
  1395. <Parameter Name="commandIdentifier" Type="System.Int32" />
  1396. <Parameter Name="recordsAffected" Type="System.Int32&amp;" RefType="out" />
  1397. <Parameter Name="error" Type="System.Exception&amp;" RefType="out" />
  1398. </Parameters>
  1399. <Docs>
  1400. <param name="commandIdentifier">To be added.</param>
  1401. <param name="recordsAffected">To be added.</param>
  1402. <param name="error">To be added.</param>
  1403. <summary>To be added.</summary>
  1404. <returns>To be added.</returns>
  1405. <remarks>To be added.</remarks>
  1406. </Docs>
  1407. </Member>
  1408. <Member MemberName="GetFillParameters">
  1409. <MemberSignature Language="C#" Value="public override System.Data.IDataParameter[] GetFillParameters ();" />
  1410. <MemberType>Method</MemberType>
  1411. <ReturnValue>
  1412. <ReturnType>System.Data.IDataParameter[]</ReturnType>
  1413. </ReturnValue>
  1414. <Parameters />
  1415. <Docs>
  1416. <remarks>To be added</remarks>
  1417. <summary>
  1418. <attribution license="cc4" from="Microsoft" modified="false" />
  1419. <para>Gets the parameters set by the user when executing an SQL SELECT statement.</para>
  1420. </summary>
  1421. <returns>
  1422. <attribution license="cc4" from="Microsoft" modified="false" />
  1423. <para>An array of <see cref="T:System.Data.IDataParameter" /> objects that contains the parameters set by the user.</para>
  1424. </returns>
  1425. </Docs>
  1426. <AssemblyInfo>
  1427. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  1428. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1429. </AssemblyInfo>
  1430. <Attributes>
  1431. <Attribute>
  1432. <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
  1433. </Attribute>
  1434. </Attributes>
  1435. </Member>
  1436. <Member MemberName="InitializeBatching">
  1437. <MemberSignature Language="C#" Value="protected virtual void InitializeBatching ();" />
  1438. <MemberType>Method</MemberType>
  1439. <AssemblyInfo>
  1440. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1441. </AssemblyInfo>
  1442. <ReturnValue>
  1443. <ReturnType>System.Void</ReturnType>
  1444. </ReturnValue>
  1445. <Parameters />
  1446. <Docs>
  1447. <remarks>
  1448. <attribution license="cc4" from="Microsoft" modified="false" />
  1449. <para>In <see cref="T:System.Data.Common.DbDataAdapter" />, this method throws <see cref="T:System.NotSupportedException" />. Classes that inherit from <see cref="T:System.Data.Common.DbDataAdapter" /> override this method to provide support for batches.</para>
  1450. </remarks>
  1451. <summary>
  1452. <attribution license="cc4" from="Microsoft" modified="false" />
  1453. <para>Initializes batching for the <see cref="T:System.Data.Common.DbDataAdapter" />.</para>
  1454. </summary>
  1455. </Docs>
  1456. </Member>
  1457. <Member MemberName="InsertCommand">
  1458. <MemberSignature Language="C#" Value="public System.Data.Common.DbCommand InsertCommand { set; get; }" />
  1459. <MemberType>Property</MemberType>
  1460. <AssemblyInfo>
  1461. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1462. </AssemblyInfo>
  1463. <Attributes>
  1464. <Attribute>
  1465. <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
  1466. </Attribute>
  1467. <Attribute>
  1468. <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
  1469. </Attribute>
  1470. </Attributes>
  1471. <ReturnValue>
  1472. <ReturnType>System.Data.Common.DbCommand</ReturnType>
  1473. </ReturnValue>
  1474. <Docs>
  1475. <value>To be added.</value>
  1476. <remarks>
  1477. <attribution license="cc4" from="Microsoft" modified="false" />
  1478. <para>During <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />, if this property is not set and primary key information is present in the <see cref="T:System.Data.DataSet" />, the <see cref="P:System.Data.IDbDataAdapter.InsertCommand" /> will be automatically generated.</para>
  1479. </remarks>
  1480. <summary>
  1481. <attribution license="cc4" from="Microsoft" modified="false" />
  1482. <para>Gets or sets a command used to insert new records into the data source.</para>
  1483. </summary>
  1484. </Docs>
  1485. </Member>
  1486. <Member MemberName="OnFillError">
  1487. <MemberSignature Language="C#" Value="protected virtual void OnFillError (System.Data.FillErrorEventArgs value);" />
  1488. <MemberType>Method</MemberType>
  1489. <ReturnValue>
  1490. <ReturnType>System.Void</ReturnType>
  1491. </ReturnValue>
  1492. <Parameters>
  1493. <Parameter Name="value" Type="System.Data.FillErrorEventArgs" />
  1494. </Parameters>
  1495. <Docs>
  1496. <param name="value">To be added: an object of type 'Data.FillErrorEventArgs'</param>
  1497. <summary>To be added</summary>
  1498. <remarks>To be added</remarks>
  1499. </Docs>
  1500. <AssemblyInfo>
  1501. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  1502. </AssemblyInfo>
  1503. </Member>
  1504. <Member MemberName="OnRowUpdated">
  1505. <MemberSignature Language="C#" Value="protected virtual void OnRowUpdated (System.Data.Common.RowUpdatedEventArgs value);" />
  1506. <MemberType>Method</MemberType>
  1507. <ReturnValue>
  1508. <ReturnType>System.Void</ReturnType>
  1509. </ReturnValue>
  1510. <Parameters>
  1511. <Parameter Name="value" Type="System.Data.Common.RowUpdatedEventArgs" />
  1512. </Parameters>
  1513. <Docs>
  1514. <remarks>
  1515. <attribution license="cc4" from="Microsoft" modified="false" />
  1516. <para>Raising an event invokes the event handler through a delegate. For an overview, see <format type="text/html"><a href="f2adaf01-1ed1-42e1-8c31-8d467e7e0ee2">Raising an Event</a></format>.</para>
  1517. </remarks>
  1518. <summary>
  1519. <attribution license="cc4" from="Microsoft" modified="false" />
  1520. <para>Raises the RowUpdated event of a .NET Framework data provider.</para>
  1521. </summary>
  1522. <param name="value">
  1523. <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Data.Common.RowUpdatedEventArgs" /> that contains the event data. </param>
  1524. </Docs>
  1525. <AssemblyInfo>
  1526. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  1527. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1528. </AssemblyInfo>
  1529. </Member>
  1530. <Member MemberName="OnRowUpdating">
  1531. <MemberSignature Language="C#" Value="protected virtual void OnRowUpdating (System.Data.Common.RowUpdatingEventArgs value);" />
  1532. <MemberType>Method</MemberType>
  1533. <ReturnValue>
  1534. <ReturnType>System.Void</ReturnType>
  1535. </ReturnValue>
  1536. <Parameters>
  1537. <Parameter Name="value" Type="System.Data.Common.RowUpdatingEventArgs" />
  1538. </Parameters>
  1539. <Docs>
  1540. <remarks>
  1541. <attribution license="cc4" from="Microsoft" modified="false" />
  1542. <para>Raising an event invokes the event handler through a delegate. For an overview, see <format type="text/html"><a href="f2adaf01-1ed1-42e1-8c31-8d467e7e0ee2">Raising an Event</a></format>.</para>
  1543. </remarks>
  1544. <summary>
  1545. <attribution license="cc4" from="Microsoft" modified="false" />
  1546. <para>Raises the RowUpdating event of a .NET Framework data provider.</para>
  1547. </summary>
  1548. <param name="value">
  1549. <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Data.Common.RowUpdatingEventArgs" /> that contains the event data. </param>
  1550. </Docs>
  1551. <AssemblyInfo>
  1552. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  1553. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1554. </AssemblyInfo>
  1555. </Member>
  1556. <Member MemberName="SelectCommand">
  1557. <MemberSignature Language="C#" Value="public System.Data.Common.DbCommand SelectCommand { set; get; }" />
  1558. <MemberType>Property</MemberType>
  1559. <AssemblyInfo>
  1560. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1561. </AssemblyInfo>
  1562. <Attributes>
  1563. <Attribute>
  1564. <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
  1565. </Attribute>
  1566. <Attribute>
  1567. <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
  1568. </Attribute>
  1569. </Attributes>
  1570. <ReturnValue>
  1571. <ReturnType>System.Data.Common.DbCommand</ReturnType>
  1572. </ReturnValue>
  1573. <Docs>
  1574. <value>To be added.</value>
  1575. <remarks>To be added.</remarks>
  1576. <summary>
  1577. <attribution license="cc4" from="Microsoft" modified="false" />
  1578. <para>Gets or sets a command used to select records in the data source.</para>
  1579. </summary>
  1580. </Docs>
  1581. </Member>
  1582. <Member MemberName="System.Data.IDbDataAdapter.DeleteCommand">
  1583. <MemberSignature Language="C#" Value="System.Data.IDbCommand System.Data.IDbDataAdapter.DeleteCommand { set; get; }" />
  1584. <MemberType>Property</MemberType>
  1585. <AssemblyInfo>
  1586. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1587. </AssemblyInfo>
  1588. <ReturnValue>
  1589. <ReturnType>System.Data.IDbCommand</ReturnType>
  1590. </ReturnValue>
  1591. <Docs>
  1592. <value>To be added.</value>
  1593. <remarks>
  1594. <attribution license="cc4" from="Microsoft" modified="false" />
  1595. <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.Common.DbDataAdapter" /> instance is cast to an <see cref="T:System.Data.IDbDataAdapter" /> interface.</para>
  1596. <para>For more information, see <see cref="P:System.Data.IDbDataAdapter.DeleteCommand" />.</para>
  1597. </remarks>
  1598. <summary>
  1599. <attribution license="cc4" from="Microsoft" modified="false" />
  1600. <para>Gets or sets an SQL statement for deleting records from the data set.</para>
  1601. </summary>
  1602. </Docs>
  1603. </Member>
  1604. <Member MemberName="System.Data.IDbDataAdapter.InsertCommand">
  1605. <MemberSignature Language="C#" Value="System.Data.IDbCommand System.Data.IDbDataAdapter.InsertCommand { set; get; }" />
  1606. <MemberType>Property</MemberType>
  1607. <AssemblyInfo>
  1608. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1609. </AssemblyInfo>
  1610. <ReturnValue>
  1611. <ReturnType>System.Data.IDbCommand</ReturnType>
  1612. </ReturnValue>
  1613. <Docs>
  1614. <value>To be added.</value>
  1615. <remarks>
  1616. <attribution license="cc4" from="Microsoft" modified="false" />
  1617. <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.Common.DbDataAdapter" /> instance is cast to an <see cref="T:System.Data.IDbDataAdapter" /> interface.</para>
  1618. <para>For more information, see <see cref="P:System.Data.IDbDataAdapter.InsertCommand" />.</para>
  1619. </remarks>
  1620. <summary>
  1621. <attribution license="cc4" from="Microsoft" modified="false" />
  1622. <para>Gets or sets an SQL statement used to insert new records into the data source.</para>
  1623. </summary>
  1624. </Docs>
  1625. </Member>
  1626. <Member MemberName="System.Data.IDbDataAdapter.SelectCommand">
  1627. <MemberSignature Language="C#" Value="System.Data.IDbCommand System.Data.IDbDataAdapter.SelectCommand { set; get; }" />
  1628. <MemberType>Property</MemberType>
  1629. <AssemblyInfo>
  1630. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1631. </AssemblyInfo>
  1632. <ReturnValue>
  1633. <ReturnType>System.Data.IDbCommand</ReturnType>
  1634. </ReturnValue>
  1635. <Docs>
  1636. <value>To be added.</value>
  1637. <remarks>
  1638. <attribution license="cc4" from="Microsoft" modified="false" />
  1639. <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.Common.DbDataAdapter" /> instance is cast to an <see cref="T:System.Data.IDbDataAdapter" /> interface.</para>
  1640. <para>For more information, see <see cref="P:System.Data.IDbDataAdapter.SelectCommand" />.</para>
  1641. </remarks>
  1642. <summary>
  1643. <attribution license="cc4" from="Microsoft" modified="false" />
  1644. <para>Gets or sets an SQL statement used to select records in the data source.</para>
  1645. </summary>
  1646. </Docs>
  1647. </Member>
  1648. <Member MemberName="System.Data.IDbDataAdapter.UpdateCommand">
  1649. <MemberSignature Language="C#" Value="System.Data.IDbCommand System.Data.IDbDataAdapter.UpdateCommand { set; get; }" />
  1650. <MemberType>Property</MemberType>
  1651. <AssemblyInfo>
  1652. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1653. </AssemblyInfo>
  1654. <ReturnValue>
  1655. <ReturnType>System.Data.IDbCommand</ReturnType>
  1656. </ReturnValue>
  1657. <Docs>
  1658. <value>To be added.</value>
  1659. <remarks>
  1660. <attribution license="cc4" from="Microsoft" modified="false" />
  1661. <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.Common.DbDataAdapter" /> instance is cast to an <see cref="T:System.Data.IDbDataAdapter" /> interface.</para>
  1662. <para>For more information, see <see cref="P:System.Data.IDbDataAdapter.UpdateCommand" />.</para>
  1663. </remarks>
  1664. <summary>
  1665. <attribution license="cc4" from="Microsoft" modified="false" />
  1666. <para>Gets or sets an SQL statement used to update records in the data source.</para>
  1667. </summary>
  1668. </Docs>
  1669. </Member>
  1670. <Member MemberName="System.ICloneable.Clone">
  1671. <MemberSignature Language="C#" Value="object ICloneable.Clone ();" />
  1672. <MemberType>Method</MemberType>
  1673. <AssemblyInfo>
  1674. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  1675. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1676. </AssemblyInfo>
  1677. <Attributes>
  1678. <Attribute>
  1679. <AttributeName>System.Obsolete("use 'protected DbDataAdapter(DbDataAdapter)' ctor")</AttributeName>
  1680. </Attribute>
  1681. </Attributes>
  1682. <ReturnValue>
  1683. <ReturnType>System.Object</ReturnType>
  1684. </ReturnValue>
  1685. <Parameters />
  1686. <Docs>
  1687. <remarks>
  1688. <attribution license="cc4" from="Microsoft" modified="false" />
  1689. <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.Common.DbDataAdapter" /> instance is cast to an <see cref="T:System.ICloneable" /> interface.</para>
  1690. <para>For more information, see <see cref="M:System.ICloneable.Clone" />.</para>
  1691. </remarks>
  1692. <summary>
  1693. <attribution license="cc4" from="Microsoft" modified="false" />
  1694. <para>Creates a new object that is a copy of the current instance.</para>
  1695. </summary>
  1696. <returns>
  1697. <attribution license="cc4" from="Microsoft" modified="false" />
  1698. <para>A new object that is a copy of this instance.</para>
  1699. </returns>
  1700. </Docs>
  1701. </Member>
  1702. <Member MemberName="TerminateBatching">
  1703. <MemberSignature Language="C#" Value="protected virtual void TerminateBatching ();" />
  1704. <MemberType>Method</MemberType>
  1705. <AssemblyInfo>
  1706. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1707. </AssemblyInfo>
  1708. <ReturnValue>
  1709. <ReturnType>System.Void</ReturnType>
  1710. </ReturnValue>
  1711. <Parameters />
  1712. <Docs>
  1713. <remarks>
  1714. <attribution license="cc4" from="Microsoft" modified="false" />
  1715. <para>In <see cref="T:System.Data.Common.DbDataAdapter" />, this method throws <see cref="T:System.NotSupportedException" />. Classes that inherit from <see cref="T:System.Data.Common.DbDataAdapter" /> override this method to provide support for batches.</para>
  1716. </remarks>
  1717. <summary>
  1718. <attribution license="cc4" from="Microsoft" modified="false" />
  1719. <para>Ends batching for the <see cref="T:System.Data.Common.DbDataAdapter" />.</para>
  1720. </summary>
  1721. </Docs>
  1722. </Member>
  1723. <Member MemberName="Update">
  1724. <MemberSignature Language="C#" Value="public int Update (System.Data.DataRow[] dataRows);" />
  1725. <MemberType>Method</MemberType>
  1726. <ReturnValue>
  1727. <ReturnType>System.Int32</ReturnType>
  1728. </ReturnValue>
  1729. <Parameters>
  1730. <Parameter Name="dataRows" Type="System.Data.DataRow[]" />
  1731. </Parameters>
  1732. <Docs>
  1733. <remarks>
  1734. <attribution license="cc4" from="Microsoft" modified="false" />
  1735. <para>When an application calls the <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> method, the <see cref="T:System.Data.Common.DbDataAdapter" /> examines the <see cref="P:System.Data.DataRow.RowState" /> property, and executes the required INSERT, UPDATE, or DELETE statements iteratively for each row, based on the order of the indexes configured in the <see cref="T:System.Data.DataSet" />. For example, <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> might execute a DELETE statement, followed by an INSERT statement, and then another DELETE statement, due to the ordering of the rows in the <see cref="T:System.Data.DataTable" />.</para>
  1736. <para>It should be noted that these statements are not performed as a batch process; each row is updated individually. An application can call the <see cref="M:System.Data.DataSet.GetChanges" /> method in situations where you must control the sequence of statement types (for example, INSERTs before UPDATEs). For more information, see <format type="text/html"><a href="d1bd9a8c-0e29-40e3-bda8-d89176b72fb1">Updating the Database with a DataAdapter and the DataSet</a></format>.</para>
  1737. <para>If INSERT, UPDATE, or DELETE statements have not been specified, the <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> method generates an exception. However, you can create a <see cref="T:System.Data.SqlClient.SqlCommandBuilder" /> or <see cref="T:System.Data.OleDb.OleDbCommandBuilder" /> object to automatically generate SQL statements for single-table updates if you set the SelectCommand property of a .NET Framework data provider. Then, any additional SQL statements that you do not set are generated by the CommandBuilder. This generation logic requires key column information to be present in the <see cref="T:System.Data.DataSet" />. For more information see <format type="text/html"><a href="6e3fb8b5-373b-4f9e-ab03-a22693df8e91">Automatically Generated Commands</a></format>.</para>
  1738. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> method retrieves rows from the table listed in the first mapping before performing an update. The <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> then refreshes the row using the value of the <see cref="P:System.Data.IDbCommand.UpdatedRowSource" /> property. Any additional rows returned are ignored.</para>
  1739. <para>After any data is loaded back into the <see cref="T:System.Data.DataSet" />, the <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)" /> event is raised, allowing the user to inspect the reconciled <see cref="T:System.Data.DataSet" /> row and any output parameters returned by the command. After a row updates successfully, the changes to that row are accepted.</para>
  1740. <para>When using <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />, the order of execution is as follows: </para>
  1741. <list type="ordered">
  1742. <item>
  1743. <para>The values in the <see cref="T:System.Data.DataRow" /> are moved to the parameter values.</para>
  1744. </item>
  1745. <item>
  1746. <para>The <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdating(System.Data.Common.RowUpdatingEventArgs)" /> event is raised.</para>
  1747. </item>
  1748. <item>
  1749. <para>The command executes.</para>
  1750. </item>
  1751. <item>
  1752. <para>If the command is set to FirstReturnedRecord, the first returned result is placed in the <see cref="T:System.Data.DataRow" />.</para>
  1753. </item>
  1754. <item>
  1755. <para>If there are output parameters, they are placed in the <see cref="T:System.Data.DataRow" />.</para>
  1756. </item>
  1757. <item>
  1758. <para>The <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)" /> event is raised.</para>
  1759. </item>
  1760. <item>
  1761. <para>
  1762. <see cref="M:System.Data.DataRow.AcceptChanges" /> is called.</para>
  1763. </item>
  1764. </list>
  1765. <para>Each command associated with the <see cref="T:System.Data.Common.DbDataAdapter" /> usually has a parameters collection associated with it. Parameters are mapped to the current row through the SourceColumn and SourceVersion properties of a .NET Framework data provider's Parameter class. SourceColumn refers to a <see cref="T:System.Data.DataTable" /> column that the <see cref="T:System.Data.Common.DbDataAdapter" /> references to obtain parameter values for the current row.</para>
  1766. <para>SourceColumn refers to the unmapped column name before any table mappings have been applied. If SourceColumn refers to a nonexistent column, the action taken depends on one of the following <see cref="T:System.Data.MissingMappingAction" /> values.</para>
  1767. <list type="table">
  1768. <listheader>
  1769. <item>
  1770. <term>
  1771. <para>Enumeration value </para>
  1772. </term>
  1773. <description>
  1774. <para>Action taken </para>
  1775. </description>
  1776. </item>
  1777. </listheader>
  1778. <item>
  1779. <term>
  1780. <para>MissingMappingAction.Passthrough </para>
  1781. </term>
  1782. <description>
  1783. <para>Use the source column names and table names in the <see cref="T:System.Data.DataSet" /> if no mapping is present. </para>
  1784. </description>
  1785. </item>
  1786. <item>
  1787. <term>
  1788. <para>MissingMappingAction.Ignore </para>
  1789. </term>
  1790. <description>
  1791. <para>A <see cref="T:System.SystemException" /> is generated. When the mappings are explicitly set, a missing mapping for an input parameter is usually the result of an error. </para>
  1792. </description>
  1793. </item>
  1794. <item>
  1795. <term>
  1796. <para>MissingMappingAction.Error </para>
  1797. </term>
  1798. <description>
  1799. <para>A <see cref="T:System.SystemException" /> is generated. </para>
  1800. </description>
  1801. </item>
  1802. </list>
  1803. <para>The SourceColumn property is also used to map the value for output or input/output parameters back to the DataSet. An exception is generated if it refers to a nonexistent column.</para>
  1804. <para>The SourceVersion property of a .NET Framework data provider's Parameter class determines whether to use the Original, Current, or Proposed version of the column value. This capability is often used to include original values in the WHERE clause of an UPDATE statement to check for optimistic concurrency violations.</para>
  1805. <block subset="none" type="note">
  1806. <para>If an error occurs while updating a row, an exception is thrown and execution of the update is discontinued. To continue the update operation without generating exceptions when an error is encountered, set the <see cref="P:System.Data.Common.DataAdapter.ContinueUpdateOnError" /> property to true before calling <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />. You may also respond to errors on a per-row basis within the RowUpdated event of a DataAdapter. To continue the update operation without generating an exception within the RowUpdated event, set the <see cref="P:System.Data.Common.RowUpdatedEventArgs.Status" /> property of the <see cref="T:System.Data.Common.RowUpdatedEventArgs" /> to <see cref="F:System.Data.UpdateStatus.Continue" />.</para>
  1807. </block>
  1808. </remarks>
  1809. <summary>
  1810. <attribution license="cc4" from="Microsoft" modified="false" />
  1811. <para>Updates the values in the database by executing the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the specified array in the <see cref="T:System.Data.DataSet" />.</para>
  1812. </summary>
  1813. <returns>
  1814. <attribution license="cc4" from="Microsoft" modified="false" />
  1815. <para>The number of rows successfully updated from the <see cref="T:System.Data.DataSet" />.</para>
  1816. </returns>
  1817. <param name="dataRows">
  1818. <attribution license="cc4" from="Microsoft" modified="false" />An array of <see cref="T:System.Data.DataRow" /> objects used to update the data source. </param>
  1819. </Docs>
  1820. <AssemblyInfo>
  1821. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  1822. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1823. </AssemblyInfo>
  1824. </Member>
  1825. <Member MemberName="Update">
  1826. <MemberSignature Language="C#" Value="public override int Update (System.Data.DataSet dataSet);" />
  1827. <MemberType>Method</MemberType>
  1828. <ReturnValue>
  1829. <ReturnType>System.Int32</ReturnType>
  1830. </ReturnValue>
  1831. <Parameters>
  1832. <Parameter Name="dataSet" Type="System.Data.DataSet" />
  1833. </Parameters>
  1834. <Docs>
  1835. <remarks>
  1836. <attribution license="cc4" from="Microsoft" modified="false" />
  1837. <para>When an application calls the <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> method, the <see cref="T:System.Data.Common.DbDataAdapter" /> examines the <see cref="P:System.Data.DataRow.RowState" /> property, and executes the required INSERT, UPDATE, or DELETE statements iteratively for each row, based on the order of the indexes configured in the <see cref="T:System.Data.DataSet" />. For example, <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> might execute a DELETE statement, followed by an INSERT statement, and then another DELETE statement, due to the ordering of the rows in the <see cref="T:System.Data.DataTable" />.</para>
  1838. <para>It should be noted that these statements are not performed as a batch process; each row is updated individually. An application can call the <see cref="M:System.Data.DataSet.GetChanges" /> method in situations where you must control the sequence of statement types (for example, INSERTs before UPDATEs). For more information, see <format type="text/html"><a href="D1BD9A8C-0E29-40E3-BDA8-D89176B72FB1">Updating the Database With a DataAdapter and a DataSet</a></format>.</para>
  1839. <para>If INSERT, UPDATE, or DELETE statements have not been specified, the <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> method generates an exception. However, you can create a <see cref="T:System.Data.SqlClient.SqlCommandBuilder" /> or <see cref="T:System.Data.OleDb.OleDbCommandBuilder" /> object to automatically generate SQL statements for single-table updates if you set the SelectCommand property of a .NET Framework data provider. Then, any additional SQL statements that you do not set are generated by the CommandBuilder. This generation logic requires key column information to be present in the <see cref="T:System.Data.DataSet" />. For more information see <format type="text/html"><a href="6e3fb8b5-373b-4f9e-ab03-a22693df8e91">Automatically Generated Commands</a></format>.</para>
  1840. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> method retrieves rows from the table listed in the first mapping before performing an update. The <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> then refreshes the row using the value of the <see cref="P:System.Data.IDbCommand.UpdatedRowSource" /> property. Any additional rows returned are ignored.</para>
  1841. <para>After any data is loaded back into the <see cref="T:System.Data.DataSet" />, the <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)" /> event is raised, allowing the user to inspect the reconciled <see cref="T:System.Data.DataSet" /> row and any output parameters returned by the command. After a row updates successfully, the changes to that row are accepted.</para>
  1842. <para>When using <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />, the order of execution is as follows: </para>
  1843. <list type="ordered">
  1844. <item>
  1845. <para>The values in the <see cref="T:System.Data.DataRow" /> are moved to the parameter values.</para>
  1846. </item>
  1847. <item>
  1848. <para>The <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdating(System.Data.Common.RowUpdatingEventArgs)" /> event is raised.</para>
  1849. </item>
  1850. <item>
  1851. <para>The command executes.</para>
  1852. </item>
  1853. <item>
  1854. <para>If the command is set to FirstReturnedRecord, then the first returned result is placed in the <see cref="T:System.Data.DataRow" />.</para>
  1855. </item>
  1856. <item>
  1857. <para>If there are output parameters, they are placed in the <see cref="T:System.Data.DataRow" />.</para>
  1858. </item>
  1859. <item>
  1860. <para>The <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)" /> event is raised.</para>
  1861. </item>
  1862. <item>
  1863. <para>
  1864. <see cref="M:System.Data.DataRow.AcceptChanges" /> is called.</para>
  1865. </item>
  1866. </list>
  1867. <para>Each command associated with the <see cref="T:System.Data.Common.DbDataAdapter" /> usually has a parameters collection associated with it. Parameters are mapped to the current row through the SourceColumn and SourceVersion properties of a .NET Framework data provider's Parameter class. SourceColumn refers to a <see cref="T:System.Data.DataTable" /> column that the <see cref="T:System.Data.Common.DbDataAdapter" /> references to obtain parameter values for the current row.</para>
  1868. <para>SourceColumn refers to the unmapped column name before any table mappings have been applied. If SourceColumn refers to a nonexistent column, the action taken depends on one of the following <see cref="T:System.Data.MissingMappingAction" /> values.</para>
  1869. <list type="table">
  1870. <listheader>
  1871. <item>
  1872. <term>
  1873. <para>Enumeration value </para>
  1874. </term>
  1875. <description>
  1876. <para>Action taken </para>
  1877. </description>
  1878. </item>
  1879. </listheader>
  1880. <item>
  1881. <term>
  1882. <para>MissingMappingAction.Passthrough </para>
  1883. </term>
  1884. <description>
  1885. <para>Use the source column names and table names in the <see cref="T:System.Data.DataSet" /> if no mapping is present. </para>
  1886. </description>
  1887. </item>
  1888. <item>
  1889. <term>
  1890. <para>MissingMappingAction.Ignore </para>
  1891. </term>
  1892. <description>
  1893. <para>A <see cref="T:System.SystemException" /> is generated. When the mappings are explicitly set, a missing mapping for an input parameter is usually the result of an error. </para>
  1894. </description>
  1895. </item>
  1896. <item>
  1897. <term>
  1898. <para>MissingMappingAction.Error </para>
  1899. </term>
  1900. <description>
  1901. <para>A <see cref="T:System.SystemException" /> is generated. </para>
  1902. </description>
  1903. </item>
  1904. </list>
  1905. <para>The SourceColumn property is also used to map the value for output or input/output parameters back to the DataSet. An exception is generated if it refers to a nonexistent column.</para>
  1906. <para>The SourceVersion property of a .NET Framework data provider's Parameter class determines whether to use the Original, Current, or Proposed version of the column value. This capability is often used to include original values in the WHERE clause of an UPDATE statement to check for optimistic concurrency violations.</para>
  1907. <block subset="none" type="note">
  1908. <para>If an error occurs while updating a row, an exception is thrown and execution of the update is discontinued. To continue the update operation without generating exceptions when an error is encountered, set the <see cref="P:System.Data.Common.DataAdapter.ContinueUpdateOnError" /> property to true before calling <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />. You may also respond to errors on a per-row basis within the RowUpdated event of a DataAdapter. To continue the update operation without generating an exception within the RowUpdated event, set the <see cref="P:System.Data.Common.RowUpdatedEventArgs.Status" /> property of the <see cref="T:System.Data.Common.RowUpdatedEventArgs" /> to <see cref="F:System.Data.UpdateStatus.Continue" />.</para>
  1909. </block>
  1910. </remarks>
  1911. <summary>
  1912. <attribution license="cc4" from="Microsoft" modified="false" />
  1913. <para>Updates the values in the database by executing the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the specified <see cref="T:System.Data.DataSet" />.</para>
  1914. </summary>
  1915. <returns>
  1916. <attribution license="cc4" from="Microsoft" modified="false" />
  1917. <para>The number of rows successfully updated from the <see cref="T:System.Data.DataSet" />.</para>
  1918. </returns>
  1919. <param name="dataSet">
  1920. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.DataSet" /> used to update the data source. </param>
  1921. </Docs>
  1922. <AssemblyInfo>
  1923. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  1924. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  1925. </AssemblyInfo>
  1926. </Member>
  1927. <Member MemberName="Update">
  1928. <MemberSignature Language="C#" Value="public int Update (System.Data.DataTable dataTable);" />
  1929. <MemberType>Method</MemberType>
  1930. <ReturnValue>
  1931. <ReturnType>System.Int32</ReturnType>
  1932. </ReturnValue>
  1933. <Parameters>
  1934. <Parameter Name="dataTable" Type="System.Data.DataTable" />
  1935. </Parameters>
  1936. <Docs>
  1937. <remarks>
  1938. <attribution license="cc4" from="Microsoft" modified="false" />
  1939. <para>When an application calls the <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> method, the <see cref="T:System.Data.Common.DbDataAdapter" /> examines the <see cref="P:System.Data.DataRow.RowState" /> property, and executes the required INSERT, UPDATE, or DELETE statements iteratively for each row, based on the order of the indexes configured in the <see cref="T:System.Data.DataSet" />. For example, <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> might execute a DELETE statement, followed by an INSERT statement, and then another DELETE statement, due to the ordering of the rows in the <see cref="T:System.Data.DataTable" />.</para>
  1940. <para>It should be noted that these statements are not performed as a batch process; each row is updated individually. An application can call the <see cref="M:System.Data.DataSet.GetChanges" /> method in situations where you must control the sequence of statement types (for example, INSERTs before UPDATEs). For more information, see <format type="text/html"><a href="D1BD9A8C-0E29-40E3-BDA8-D89176B72FB1">Updating the Database With a DataAdapter and a DataSet</a></format>.</para>
  1941. <para>If INSERT, UPDATE, or DELETE statements have not been specified, the <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> method generates an exception. However, you can create a <see cref="T:System.Data.SqlClient.SqlCommandBuilder" /> or <see cref="T:System.Data.OleDb.OleDbCommandBuilder" /> object to automatically generate SQL statements for single-table updates if you set the SelectCommand property of a .NET Framework data provider. Then, any additional SQL statements that you do not set are generated by the CommandBuilder. This generation logic requires key column information to be present in the <see cref="T:System.Data.DataSet" />. For more information see <format type="text/html"><a href="6e3fb8b5-373b-4f9e-ab03-a22693df8e91">Automatically Generated Commands</a></format>.</para>
  1942. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> method retrieves rows from the table listed in the first mapping before performing an update. The <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> then refreshes the row using the value of the <see cref="P:System.Data.IDbCommand.UpdatedRowSource" /> property. Any additional rows returned are ignored.</para>
  1943. <para>After any data is loaded back into the <see cref="T:System.Data.DataSet" />, the <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)" /> event is raised, allowing the user to inspect the reconciled <see cref="T:System.Data.DataSet" /> row and any output parameters returned by the command. After a row updates successfully, the changes to that row are accepted.</para>
  1944. <para>When using <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />, the order of execution is as follows: </para>
  1945. <list type="ordered">
  1946. <item>
  1947. <para>The values in the <see cref="T:System.Data.DataRow" /> are moved to the parameter values.</para>
  1948. </item>
  1949. <item>
  1950. <para>The <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdating(System.Data.Common.RowUpdatingEventArgs)" /> event is raised.</para>
  1951. </item>
  1952. <item>
  1953. <para>The command executes.</para>
  1954. </item>
  1955. <item>
  1956. <para>If the command is set to FirstReturnedRecord, then the first returned result is placed in the <see cref="T:System.Data.DataRow" />.</para>
  1957. </item>
  1958. <item>
  1959. <para>If there are output parameters, they are placed in the <see cref="T:System.Data.DataRow" />.</para>
  1960. </item>
  1961. <item>
  1962. <para>The <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)" /> event is raised.</para>
  1963. </item>
  1964. <item>
  1965. <para>
  1966. <see cref="M:System.Data.DataRow.AcceptChanges" /> is called.</para>
  1967. </item>
  1968. </list>
  1969. <para>Each command associated with the <see cref="T:System.Data.Common.DbDataAdapter" /> usually has a parameters collection associated with it. Parameters are mapped to the current row through the SourceColumn and SourceVersion properties of a .NET Framework data provider's Parameter class. SourceColumn refers to a <see cref="T:System.Data.DataTable" /> column that the <see cref="T:System.Data.Common.DbDataAdapter" /> references to obtain parameter values for the current row.</para>
  1970. <para>SourceColumn refers to the unmapped column name before any table mappings have been applied. If SourceColumn refers to a nonexistent column, the action taken depends on one of the following <see cref="T:System.Data.MissingMappingAction" /> values.</para>
  1971. <list type="table">
  1972. <listheader>
  1973. <item>
  1974. <term>
  1975. <para>Enumeration value </para>
  1976. </term>
  1977. <description>
  1978. <para>Action taken </para>
  1979. </description>
  1980. </item>
  1981. </listheader>
  1982. <item>
  1983. <term>
  1984. <para>MissingMappingAction.Passthrough </para>
  1985. </term>
  1986. <description>
  1987. <para>Use the source column names and table names in the <see cref="T:System.Data.DataSet" /> if no mapping is present. </para>
  1988. </description>
  1989. </item>
  1990. <item>
  1991. <term>
  1992. <para>MissingMappingAction.Ignore </para>
  1993. </term>
  1994. <description>
  1995. <para>A <see cref="T:System.SystemException" /> is generated. When the mappings are explicitly set, a missing mapping for an input parameter is usually the result of an error. </para>
  1996. </description>
  1997. </item>
  1998. <item>
  1999. <term>
  2000. <para>MissingMappingAction.Error </para>
  2001. </term>
  2002. <description>
  2003. <para>A <see cref="T:System.SystemException" /> is generated. </para>
  2004. </description>
  2005. </item>
  2006. </list>
  2007. <para>The SourceColumn property is also used to map the value for output or input/output parameters back to the DataSet. An exception is generated if it refers to a nonexistent column.</para>
  2008. <para>The SourceVersion property of a .NET Framework data provider's Parameter class determines whether to use the Original, Current, or Proposed version of the column value. This capability is often used to include original values in the WHERE clause of an UPDATE statement to check for optimistic concurrency violations.</para>
  2009. <block subset="none" type="note">
  2010. <para>If an error occurs while updating a row, an exception is thrown and execution of the update is discontinued. To continue the update operation without generating exceptions when an error is encountered, set the <see cref="P:System.Data.Common.DataAdapter.ContinueUpdateOnError" /> property to true before calling <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />. You may also respond to errors on a per-row basis within the RowUpdated event of a DataAdapter. To continue the update operation without generating an exception within the RowUpdated event, set the <see cref="P:System.Data.Common.RowUpdatedEventArgs.Status" /> property of the <see cref="T:System.Data.Common.RowUpdatedEventArgs" /> to <see cref="F:System.Data.UpdateStatus.Continue" />.</para>
  2011. </block>
  2012. </remarks>
  2013. <summary>
  2014. <attribution license="cc4" from="Microsoft" modified="false" />
  2015. <para>Updates the values in the database by executing the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the specified <see cref="T:System.Data.DataTable" />.</para>
  2016. </summary>
  2017. <returns>
  2018. <attribution license="cc4" from="Microsoft" modified="false" />
  2019. <para>The number of rows successfully updated from the <see cref="T:System.Data.DataTable" />.</para>
  2020. </returns>
  2021. <param name="dataTable">
  2022. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.DataTable" /> used to update the data source. </param>
  2023. </Docs>
  2024. <AssemblyInfo>
  2025. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  2026. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  2027. </AssemblyInfo>
  2028. </Member>
  2029. <Member MemberName="Update">
  2030. <MemberSignature Language="C#" Value="protected virtual int Update (System.Data.DataRow[] dataRows, System.Data.Common.DataTableMapping tableMapping);" />
  2031. <MemberType>Method</MemberType>
  2032. <ReturnValue>
  2033. <ReturnType>System.Int32</ReturnType>
  2034. </ReturnValue>
  2035. <Parameters>
  2036. <Parameter Name="dataRows" Type="System.Data.DataRow[]" />
  2037. <Parameter Name="tableMapping" Type="System.Data.Common.DataTableMapping" />
  2038. </Parameters>
  2039. <Docs>
  2040. <remarks>
  2041. <attribution license="cc4" from="Microsoft" modified="false" />
  2042. <para>When an application calls the <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> method, the <see cref="T:System.Data.Common.DbDataAdapter" /> examines the <see cref="P:System.Data.DataRow.RowState" /> property, and executes the required INSERT, UPDATE, or DELETE statements iteratively for each row, based on the order of the indexes configured in the <see cref="T:System.Data.DataSet" />. For example, <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> might execute a DELETE statement, followed by an INSERT statement, and then another DELETE statement, due to the ordering of the rows in the <see cref="T:System.Data.DataTable" />.</para>
  2043. <para>It should be noted that these statements are not performed as a batch process; each row is updated individually. An application can call the <see cref="M:System.Data.DataSet.GetChanges" /> method in situations where you must control the sequence of statement types (for example, INSERTs before UPDATEs). For more information, see <format type="text/html"><a href="d1bd9a8c-0e29-40e3-bda8-d89176b72fb1">Updating the Database with a DataAdapter and the DataSet</a></format>.</para>
  2044. <para>If INSERT, UPDATE, or DELETE statements have not been specified, the <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> method generates an exception. However, you can create a <see cref="T:System.Data.SqlClient.SqlCommandBuilder" /> or <see cref="T:System.Data.OleDb.OleDbCommandBuilder" /> object to automatically generate SQL statements for single-table updates if you set the SelectCommand property of a .NET Framework data provider. Then, any additional SQL statements that you do not set are generated by the CommandBuilder. This generation logic requires key column information to be present in the <see cref="T:System.Data.DataSet" />. For more information see <format type="text/html"><a href="6e3fb8b5-373b-4f9e-ab03-a22693df8e91">Automatically Generated Commands</a></format>.</para>
  2045. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> method retrieves rows from the table listed in the first mapping before performing an update. The <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> then refreshes the row using the value of the <see cref="P:System.Data.IDbCommand.UpdatedRowSource" /> property. Any additional rows returned are ignored.</para>
  2046. <para>After any data is loaded back into the <see cref="T:System.Data.DataSet" />, the <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)" /> event is raised, allowing the user to inspect the reconciled <see cref="T:System.Data.DataSet" /> row and any output parameters returned by the command. After a row updates successfully, the changes to that row are accepted.</para>
  2047. <para>When using <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />, the order of execution is as follows: </para>
  2048. <list type="ordered">
  2049. <item>
  2050. <para>The values in the <see cref="T:System.Data.DataRow" /> are moved to the parameter values.</para>
  2051. </item>
  2052. <item>
  2053. <para>The <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdating(System.Data.Common.RowUpdatingEventArgs)" /> event is raised.</para>
  2054. </item>
  2055. <item>
  2056. <para>The command executes.</para>
  2057. </item>
  2058. <item>
  2059. <para>If the command is set to FirstReturnedRecord, then the first returned result is placed in the <see cref="T:System.Data.DataRow" />.</para>
  2060. </item>
  2061. <item>
  2062. <para>If there are output parameters, they are placed in the <see cref="T:System.Data.DataRow" />.</para>
  2063. </item>
  2064. <item>
  2065. <para>The <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)" /> event is raised.</para>
  2066. </item>
  2067. <item>
  2068. <para>
  2069. <see cref="M:System.Data.DataRow.AcceptChanges" /> is called.</para>
  2070. </item>
  2071. </list>
  2072. <para>Each command associated with the <see cref="T:System.Data.Common.DbDataAdapter" /> usually has a parameters collection associated with it. Parameters are mapped to the current row through the SourceColumn and SourceVersion properties of a .NET Framework data provider's Parameter class. SourceColumn refers to a <see cref="T:System.Data.DataTable" /> column that the <see cref="T:System.Data.Common.DbDataAdapter" /> references to obtain parameter values for the current row.</para>
  2073. <para>SourceColumn refers to the unmapped column name before any table mappings have been applied. If SourceColumn refers to a nonexistent column, the action taken depends on one of the following <see cref="T:System.Data.MissingMappingAction" /> values.</para>
  2074. <list type="table">
  2075. <listheader>
  2076. <item>
  2077. <term>
  2078. <para>Enumeration value </para>
  2079. </term>
  2080. <description>
  2081. <para>Action taken </para>
  2082. </description>
  2083. </item>
  2084. </listheader>
  2085. <item>
  2086. <term>
  2087. <para>MissingMappingAction.Passthrough </para>
  2088. </term>
  2089. <description>
  2090. <para>Use the source column names and table names in the <see cref="T:System.Data.DataSet" /> if no mapping is present. </para>
  2091. </description>
  2092. </item>
  2093. <item>
  2094. <term>
  2095. <para>MissingMappingAction.Ignore </para>
  2096. </term>
  2097. <description>
  2098. <para>A <see cref="T:System.SystemException" /> is generated. When the mappings are explicitly set, a missing mapping for an input parameter is usually the result of an error. </para>
  2099. </description>
  2100. </item>
  2101. <item>
  2102. <term>
  2103. <para>MissingMappingAction.Error </para>
  2104. </term>
  2105. <description>
  2106. <para>A <see cref="T:System.SystemException" /> is generated. </para>
  2107. </description>
  2108. </item>
  2109. </list>
  2110. <para>The SourceColumn property is also used to map the value for output or input/output parameters back to the DataSet. An exception is generated if it refers to a nonexistent column.</para>
  2111. <para>The SourceVersion property of a .NET Framework data provider's Parameter class determines whether to use the Original, Current, or Proposed version of the column value. This capability is often used to include original values in the WHERE clause of an UPDATE statement to check for optimistic concurrency violations.</para>
  2112. <block subset="none" type="note">
  2113. <para>If an error occurs while updating a row, an exception is thrown and execution of the update is discontinued. To continue the update operation without generating exceptions when an error is encountered, set the <see cref="P:System.Data.Common.DataAdapter.ContinueUpdateOnError" /> property to true before calling <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />. You may also respond to errors on a per-row basis within the RowUpdated event of a DataAdapter. To continue the update operation without generating an exception within the RowUpdated event, set the <see cref="P:System.Data.Common.RowUpdatedEventArgs.Status" /> property of the <see cref="T:System.Data.Common.RowUpdatedEventArgs" /> to <see cref="F:System.Data.UpdateStatus.Continue" />.</para>
  2114. </block>
  2115. </remarks>
  2116. <summary>
  2117. <attribution license="cc4" from="Microsoft" modified="false" />
  2118. <para>Updates the values in the database by executing the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the specified array of <see cref="T:System.Data.DataSet" /> objects.</para>
  2119. </summary>
  2120. <returns>
  2121. <attribution license="cc4" from="Microsoft" modified="false" />
  2122. <para>The number of rows successfully updated from the <see cref="T:System.Data.DataSet" />.</para>
  2123. </returns>
  2124. <param name="dataRows">
  2125. <attribution license="cc4" from="Microsoft" modified="false" />An array of <see cref="T:System.Data.DataRow" /> objects used to update the data source. </param>
  2126. <param name="tableMapping">
  2127. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="P:System.Data.IDataAdapter.TableMappings" /> collection to use. </param>
  2128. </Docs>
  2129. <AssemblyInfo>
  2130. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  2131. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  2132. </AssemblyInfo>
  2133. </Member>
  2134. <Member MemberName="Update">
  2135. <MemberSignature Language="C#" Value="public int Update (System.Data.DataSet dataSet, string srcTable);" />
  2136. <MemberType>Method</MemberType>
  2137. <ReturnValue>
  2138. <ReturnType>System.Int32</ReturnType>
  2139. </ReturnValue>
  2140. <Parameters>
  2141. <Parameter Name="dataSet" Type="System.Data.DataSet" />
  2142. <Parameter Name="srcTable" Type="System.String" />
  2143. </Parameters>
  2144. <Docs>
  2145. <remarks>
  2146. <attribution license="cc4" from="Microsoft" modified="false" />
  2147. <para>When an application calls the <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> method, the <see cref="T:System.Data.Common.DbDataAdapter" /> examines the <see cref="P:System.Data.DataRow.RowState" /> property, and executes the required INSERT, UPDATE, or DELETE statements iteratively for each row, based on the order of the indexes configured in the <see cref="T:System.Data.DataSet" />. For example, <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> might execute a DELETE statement, followed by an INSERT statement, and then another DELETE statement, due to the ordering of the rows in the <see cref="T:System.Data.DataTable" />.</para>
  2148. <para>It should be noted that these statements are not performed as a batch process; each row is updated individually. An application can call the <see cref="M:System.Data.DataSet.GetChanges" /> method in situations where you must control the sequence of statement types (for example, INSERT before UPDATE). For more information, see <format type="text/html"><a href="D1BD9A8C-0E29-40E3-BDA8-D89176B72FB1">Updating the Database With a DataAdapter and a DataSet</a></format>.</para>
  2149. <para>If INSERT, UPDATE, or DELETE statements have not been specified, the <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> method generates an exception. However, you can create a <see cref="T:System.Data.SqlClient.SqlCommandBuilder" /> or <see cref="T:System.Data.OleDb.OleDbCommandBuilder" /> object to automatically generate SQL statements for single-table updates if you set the SelectCommand property of a .NET Framework data provider. Then, any additional SQL statements that you do not set are generated by the CommandBuilder. This generation logic requires key column information to be present in the <see cref="T:System.Data.DataSet" />. For more information see <format type="text/html"><a href="6e3fb8b5-373b-4f9e-ab03-a22693df8e91">Automatically Generated Commands</a></format>.</para>
  2150. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> method supports scenarios where the <see cref="T:System.Data.DataSet" /> contains multiple <see cref="T:System.Data.DataTable" /> objects whose names differ only by case. When multiple tables with the same name, but different case, exist in a DataSet, <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> performs a case-sensitive comparison to find the corresponding table, and generates an exception if no exact match exists. The following C# code illustrates this behavior.</para>
  2151. <code>DataSet ds = new DataSet();
  2152. ds.Tables.Add("aaa");
  2153. ds.Tables.Add("AAA");
  2154. adapter.Update(ds, "aaa"); // Updates "aaa", which already exists in the DataSet.
  2155. adapter.Update(ds, "AAA"); // Updates "AAA", which already exists in the DataSet.
  2156. adapter.Update(ds, "Aaa"); // Results in an exception.</code>
  2157. <para>If <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> is called and the <see cref="T:System.Data.DataSet" /> contains only one <see cref="T:System.Data.DataTable" /> whose name differs only by case, that <see cref="T:System.Data.DataTable" /> is updated. In this scenario, the comparison is case insensitive. The following C# code illustrates this behavior.</para>
  2158. <code>DataSet dataset = new DataSet();
  2159. dataset.Tables.Add("aaa");
  2160. adapter.Update(dataset, "AAA"); // Updates table "aaa" because only one similarly named table is in the DataSet.</code>
  2161. <para>The <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> method retrieves rows from the table listed in the first mapping before performing an update. The <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> then refreshes the row using the value of the <see cref="P:System.Data.IDbCommand.UpdatedRowSource" /> property. Any additional rows returned are ignored.</para>
  2162. <para>After any data is loaded back into the <see cref="T:System.Data.DataSet" />, the <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)" /> event is raised, allowing the user to inspect the reconciled <see cref="T:System.Data.DataSet" /> row and any output parameters returned by the command. After a row updates successfully, the changes to that row are accepted.</para>
  2163. <para>When using <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />, the order of execution is as follows: </para>
  2164. <list type="ordered">
  2165. <item>
  2166. <para>The values in the <see cref="T:System.Data.DataRow" /> are moved to the parameter values.</para>
  2167. </item>
  2168. <item>
  2169. <para>The <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdating(System.Data.Common.RowUpdatingEventArgs)" /> event is raised.</para>
  2170. </item>
  2171. <item>
  2172. <para>The command executes.</para>
  2173. </item>
  2174. <item>
  2175. <para>If the command is set to FirstReturnedRecord, then the first returned result is placed in the <see cref="T:System.Data.DataRow" />.</para>
  2176. </item>
  2177. <item>
  2178. <para>If there are output parameters, they are placed in the <see cref="T:System.Data.DataRow" />.</para>
  2179. </item>
  2180. <item>
  2181. <para>The <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)" /> event is raised.</para>
  2182. </item>
  2183. <item>
  2184. <para>
  2185. <see cref="M:System.Data.DataRow.AcceptChanges" /> is called.</para>
  2186. </item>
  2187. </list>
  2188. <para>Each command associated with the <see cref="T:System.Data.Common.DbDataAdapter" /> usually has a parameters collection associated with it. Parameters are mapped to the current row through the SourceColumn and SourceVersion properties of a .NET Framework data provider's Parameter class. SourceColumn refers to a <see cref="T:System.Data.DataTable" /> column that the <see cref="T:System.Data.Common.DbDataAdapter" /> references to obtain parameter values for the current row.</para>
  2189. <para>SourceColumn refers to the unmapped column name before any table mappings have been applied. If SourceColumn refers to a nonexistent column, the action taken depends on one of the following <see cref="T:System.Data.MissingMappingAction" /> values.</para>
  2190. <list type="table">
  2191. <listheader>
  2192. <item>
  2193. <term>
  2194. <para>Enumeration value </para>
  2195. </term>
  2196. <description>
  2197. <para>Action taken </para>
  2198. </description>
  2199. </item>
  2200. </listheader>
  2201. <item>
  2202. <term>
  2203. <para>MissingMappingAction.Passthrough </para>
  2204. </term>
  2205. <description>
  2206. <para>Use the source column names and table names in the <see cref="T:System.Data.DataSet" /> if no mapping is present. </para>
  2207. </description>
  2208. </item>
  2209. <item>
  2210. <term>
  2211. <para>MissingMappingAction.Ignore </para>
  2212. </term>
  2213. <description>
  2214. <para>A <see cref="T:System.SystemException" /> is generated. When the mappings are explicitly set, a missing mapping for an input parameter is usually the result of an error. </para>
  2215. </description>
  2216. </item>
  2217. <item>
  2218. <term>
  2219. <para>MissingMappingAction.Error </para>
  2220. </term>
  2221. <description>
  2222. <para>A <see cref="T:System.SystemException" /> is generated. </para>
  2223. </description>
  2224. </item>
  2225. </list>
  2226. <para>The SourceColumn property is also used to map the value for output or input/output parameters back to the DataSet. An exception is generated if it refers to a nonexistent column.</para>
  2227. <para>The SourceVersion property of a .NET Framework data provider's Parameter class determines whether to use the Original, Current, or Proposed version of the column value. This capability is often used to include original values in the WHERE clause of an UPDATE statement to check for optimistic concurrency violations.</para>
  2228. <block subset="none" type="note">
  2229. <para>If an error occurs while updating a row, an exception is thrown and execution of the update is discontinued. To continue the update operation without generating exceptions when an error is encountered, set the <see cref="P:System.Data.Common.DataAdapter.ContinueUpdateOnError" /> property to true before calling <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />. You may also respond to errors on a per-row basis within the RowUpdated event of a DataAdapter. To continue the update operation without generating an exception within the RowUpdated event, set the <see cref="P:System.Data.Common.RowUpdatedEventArgs.Status" /> property of the <see cref="T:System.Data.Common.RowUpdatedEventArgs" /> to <see cref="F:System.Data.UpdateStatus.Continue" />.</para>
  2230. </block>
  2231. </remarks>
  2232. <summary>
  2233. <attribution license="cc4" from="Microsoft" modified="false" />
  2234. <para>Updates the values in the database by executing the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the <see cref="T:System.Data.DataSet" /> with the specified <see cref="T:System.Data.DataTable" /> name.</para>
  2235. </summary>
  2236. <returns>
  2237. <attribution license="cc4" from="Microsoft" modified="false" />
  2238. <para>The number of rows successfully updated from the <see cref="T:System.Data.DataSet" />.</para>
  2239. </returns>
  2240. <param name="dataSet">
  2241. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.DataSet" /> to use to update the data source. </param>
  2242. <param name="srcTable">
  2243. <attribution license="cc4" from="Microsoft" modified="false" />The name of the source table to use for table mapping. </param>
  2244. </Docs>
  2245. <AssemblyInfo>
  2246. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  2247. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  2248. </AssemblyInfo>
  2249. </Member>
  2250. <Member MemberName="UpdateBatchSize">
  2251. <MemberSignature Language="C#" Value="public virtual int UpdateBatchSize { set; get; }" />
  2252. <MemberType>Property</MemberType>
  2253. <AssemblyInfo>
  2254. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  2255. </AssemblyInfo>
  2256. <Attributes>
  2257. <Attribute>
  2258. <AttributeName>System.ComponentModel.DefaultValue(1)</AttributeName>
  2259. </Attribute>
  2260. </Attributes>
  2261. <ReturnValue>
  2262. <ReturnType>System.Int32</ReturnType>
  2263. </ReturnValue>
  2264. <Docs>
  2265. <value>To be added.</value>
  2266. <remarks>
  2267. <attribution license="cc4" from="Microsoft" modified="false" />
  2268. <para>Use the <see cref="P:System.Data.Common.DbDataAdapter.UpdateBatchSize" /> property to update a data source with changes from a <see cref="T:System.Data.DataSet" />. If the data provider supports batch processing, this can increase application performance by reducing the number of round-trips to the server. In ADO.NET 2.0, this property is supported for the .NET data providers for SQL Server (SqlClient) and Oracle (OracleClient). </para>
  2269. <para>Executing an extremely large batch could decrease performance. Therefore, you should test for the optimum batch size setting before implementing your application.</para>
  2270. <para>An <see cref="T:System.ArgumentOutOfRangeException" /> will be thrown if the value is set to a number less than zero.</para>
  2271. </remarks>
  2272. <summary>
  2273. <attribution license="cc4" from="Microsoft" modified="false" />
  2274. <para>Gets or sets a value that enables or disables batch processing support, and specifies the number of commands that can be executed in a batch. </para>
  2275. </summary>
  2276. </Docs>
  2277. </Member>
  2278. <Member MemberName="UpdateCommand">
  2279. <MemberSignature Language="C#" Value="public System.Data.Common.DbCommand UpdateCommand { set; get; }" />
  2280. <MemberType>Property</MemberType>
  2281. <AssemblyInfo>
  2282. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  2283. </AssemblyInfo>
  2284. <Attributes>
  2285. <Attribute>
  2286. <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
  2287. </Attribute>
  2288. <Attribute>
  2289. <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
  2290. </Attribute>
  2291. </Attributes>
  2292. <ReturnValue>
  2293. <ReturnType>System.Data.Common.DbCommand</ReturnType>
  2294. </ReturnValue>
  2295. <Docs>
  2296. <value>To be added.</value>
  2297. <remarks>
  2298. <attribution license="cc4" from="Microsoft" modified="false" />
  2299. <para>During <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />, if this property is not set and primary key information is present in the <see cref="T:System.Data.DataSet" />, the <see cref="P:System.Data.IDbDataAdapter.UpdateCommand" /> will be automatically generated.</para>
  2300. </remarks>
  2301. <summary>
  2302. <attribution license="cc4" from="Microsoft" modified="false" />
  2303. <para>Gets or sets a command used to update records in the data source.</para>
  2304. </summary>
  2305. </Docs>
  2306. </Member>
  2307. </Members>
  2308. </Type>