OdbcDataAdapter.xml 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <Type Name="OdbcDataAdapter" FullName="System.Data.Odbc.OdbcDataAdapter">
  3. <TypeSignature Language="C#" Value="public sealed class OdbcDataAdapter : System.Data.Common.DbDataAdapter" />
  4. <AssemblyInfo>
  5. <AssemblyName>System.Data</AssemblyName>
  6. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  7. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  8. </AssemblyInfo>
  9. <Base>
  10. <BaseTypeName>System.Data.Common.DbDataAdapter</BaseTypeName>
  11. </Base>
  12. <Interfaces>
  13. </Interfaces>
  14. <Attributes>
  15. <Attribute>
  16. <AttributeName>System.ComponentModel.ToolboxItem("Microsoft.VSDesigner.Data.VS.OdbcDataAdapterToolboxItem, Microsoft.VSDesigner, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
  17. </Attribute>
  18. <Attribute>
  19. <AttributeName>System.ComponentModel.Designer("Microsoft.VSDesigner.Data.VS.OdbcDataAdapterDesigner, Microsoft.VSDesigner, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.IDesigner")</AttributeName>
  20. </Attribute>
  21. <Attribute>
  22. <AttributeName>System.ComponentModel.DefaultEvent("RowUpdated")</AttributeName>
  23. </Attribute>
  24. </Attributes>
  25. <Docs>
  26. <remarks>
  27. <attribution license="cc4" from="Microsoft" modified="false" />
  28. <para>The <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> serves as a bridge between a DataSet and data source for retrieving and saving data. The <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> provides this bridge by using <see cref="M:System.Data.Common.DbDataAdapter.Fill(System.Data.DataSet)" /> to load data from the data source into the <see cref="T:System.Data.DataSet" />, and using <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> to send changes made in the <see cref="T:System.Data.DataSet" /> back to the data source.</para>
  29. <para>When the <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> fills a <see cref="T:System.Data.DataSet" />, it creates the required tables and columns for the returned data if they do not already exist. However, primary key information is not included in the implicitly created schema unless the <see cref="P:System.Data.Common.DataAdapter.MissingSchemaAction" /> property is set to <see cref="F:System.Data.MissingSchemaAction.AddWithKey" />. You may also have the <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> create the schema of the <see cref="T:System.Data.DataSet" />, including primary key information, before filling it with data using <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" />. For more information, see <format type="text/html"><a href="307d2809-208b-4cf8-b6a9-5d16f15fc16c">Adding Existing Constraints to a DataSet</a></format>.</para>
  30. <block subset="none" type="note">
  31. <para>When you call the Fill method on a data source that does not have a primary key column, the <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> tries to promote the unique constraint column to the primary key. In the process, the <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> marks the unique constraint as not nullable. This behavior works unless there is a null value in the unique constraint column. If there is a null value, the Fill method fails with a constraint violation. To avoid this situation, do not allow null values in the unique constraint column.</para>
  32. </block>
  33. <block subset="none" type="note">
  34. <para>Due to the limitations of native ODBC drivers, only one <see cref="T:System.Data.DataTable" /> is ever returned when you call <see cref="M:System.Data.Common.DbDataAdapter.FillSchema(System.Data.DataTable,System.Data.SchemaType)" />. This is true even when executing SQL batch statements from which multiple <see cref="T:System.Data.DataTable" /> objects would be expected.</para>
  35. </block>
  36. <para>The <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> also includes the <see cref="P:System.Data.Odbc.OdbcDataAdapter.SelectCommand" />, <see cref="P:System.Data.Odbc.OdbcDataAdapter.InsertCommand" />, <see cref="P:System.Data.Odbc.OdbcDataAdapter.DeleteCommand" />, <see cref="P:System.Data.Odbc.OdbcDataAdapter.UpdateCommand" />, and TableMappings properties to facilitate loading and updating of data.</para>
  37. </remarks>
  38. <summary>
  39. <attribution license="cc4" from="Microsoft" modified="false" />
  40. <para>Represents a set of data commands and a connection to a data source that are used to fill the <see cref="T:System.Data.DataSet" /> and update the data source. This class cannot be inherited.</para>
  41. </summary>
  42. </Docs>
  43. <Members>
  44. <Member MemberName=".ctor">
  45. <MemberSignature Language="C#" Value="public OdbcDataAdapter ();" />
  46. <MemberType>Constructor</MemberType>
  47. <Parameters />
  48. <Docs>
  49. <remarks>
  50. <attribution license="cc4" from="Microsoft" modified="false" />
  51. <para>When you create an instance of <see cref="T:System.Data.Odbc.OdbcDataAdapter" />, the following write-only and read-only properties are set to their default values, as shown in the table.</para>
  52. <list type="table">
  53. <listheader>
  54. <item>
  55. <term>
  56. <para>Properties </para>
  57. </term>
  58. <description>
  59. <para>Default value </para>
  60. </description>
  61. </item>
  62. </listheader>
  63. <item>
  64. <term>
  65. <para>
  66. <see cref="P:System.Data.Common.DataAdapter.MissingMappingAction" /> </para>
  67. </term>
  68. <description>
  69. <para>MissingMappingAction.Passthrough </para>
  70. </description>
  71. </item>
  72. <item>
  73. <term>
  74. <para>
  75. <see cref="P:System.Data.Common.DataAdapter.MissingSchemaAction" /> </para>
  76. </term>
  77. <description>
  78. <para>MissingSchemaAction.Add </para>
  79. </description>
  80. </item>
  81. </list>
  82. <para>You can change the value of any of these properties through a separate call to the property.</para>
  83. </remarks>
  84. <summary>
  85. <attribution license="cc4" from="Microsoft" modified="false" />
  86. <para>Initializes a new instance of the <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> class.</para>
  87. </summary>
  88. </Docs>
  89. <AssemblyInfo>
  90. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  91. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  92. </AssemblyInfo>
  93. </Member>
  94. <Member MemberName=".ctor">
  95. <MemberSignature Language="C#" Value="public OdbcDataAdapter (System.Data.Odbc.OdbcCommand selectCommand);" />
  96. <MemberType>Constructor</MemberType>
  97. <Parameters>
  98. <Parameter Name="selectCommand" Type="System.Data.Odbc.OdbcCommand" />
  99. </Parameters>
  100. <Docs>
  101. <remarks>
  102. <attribution license="cc4" from="Microsoft" modified="false" />
  103. <para>This implementation of the <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> constructor sets the <see cref="P:System.Data.Odbc.OdbcDataAdapter.SelectCommand" /> property to the value specified in the <paramref name="selectCommand" /> parameter.</para>
  104. <para>When you create an instance of <see cref="T:System.Data.Odbc.OdbcDataAdapter" />, the following write-only and read-only properties are set to their default values, as shown in the table.</para>
  105. <list type="table">
  106. <listheader>
  107. <item>
  108. <term>
  109. <para>Properties </para>
  110. </term>
  111. <description>
  112. <para>Initial value </para>
  113. </description>
  114. </item>
  115. </listheader>
  116. <item>
  117. <term>
  118. <para>
  119. <see cref="P:System.Data.Common.DataAdapter.MissingMappingAction" /> </para>
  120. </term>
  121. <description>
  122. <para>MissingMappingAction.Passthrough </para>
  123. </description>
  124. </item>
  125. <item>
  126. <term>
  127. <para>
  128. <see cref="P:System.Data.Common.DataAdapter.MissingSchemaAction" /> </para>
  129. </term>
  130. <description>
  131. <para>MissingSchemaAction.Add </para>
  132. </description>
  133. </item>
  134. </list>
  135. <para>You can change the value of any of these properties through a separate call to the property.</para>
  136. </remarks>
  137. <summary>
  138. <attribution license="cc4" from="Microsoft" modified="false" />
  139. <para>Initializes a new instance of the <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> class with the specified SQL SELECT statement.</para>
  140. </summary>
  141. <param name="selectCommand">
  142. <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Data.Odbc.OdbcCommand" /> that is an SQL SELECT statement or stored procedure, and is set as the <see cref="P:System.Data.Odbc.OdbcDataAdapter.SelectCommand" /> property of the <see cref="T:System.Data.Odbc.OdbcDataAdapter" />. </param>
  143. </Docs>
  144. <AssemblyInfo>
  145. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  146. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  147. </AssemblyInfo>
  148. </Member>
  149. <Member MemberName=".ctor">
  150. <MemberSignature Language="C#" Value="public OdbcDataAdapter (string selectCommandText, System.Data.Odbc.OdbcConnection selectConnection);" />
  151. <MemberType>Constructor</MemberType>
  152. <Parameters>
  153. <Parameter Name="selectCommandText" Type="System.String" />
  154. <Parameter Name="selectConnection" Type="System.Data.Odbc.OdbcConnection" />
  155. </Parameters>
  156. <Docs>
  157. <remarks>
  158. <attribution license="cc4" from="Microsoft" modified="false" />
  159. <para>This implementation of the <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> can be useful in an application that must call the Fill method for two or more <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> objects.</para>
  160. </remarks>
  161. <summary>
  162. <attribution license="cc4" from="Microsoft" modified="false" />
  163. <para>Initializes a new instance of the <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> class with an SQL SELECT statement and an <see cref="T:System.Data.Odbc.OdbcConnection" />.</para>
  164. </summary>
  165. <param name="selectCommandText">
  166. <attribution license="cc4" from="Microsoft" modified="false" />A string that is a SQL SELECT statement or stored procedure to be used by the <see cref="P:System.Data.Odbc.OdbcDataAdapter.SelectCommand" /> property of the <see cref="T:System.Data.Odbc.OdbcDataAdapter" />. </param>
  167. <param name="selectConnection">
  168. <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Data.Odbc.OdbcConnection" /> that represents the connection. </param>
  169. </Docs>
  170. <AssemblyInfo>
  171. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  172. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  173. </AssemblyInfo>
  174. </Member>
  175. <Member MemberName=".ctor">
  176. <MemberSignature Language="C#" Value="public OdbcDataAdapter (string selectCommandText, string selectConnectionString);" />
  177. <MemberType>Constructor</MemberType>
  178. <Parameters>
  179. <Parameter Name="selectCommandText" Type="System.String" />
  180. <Parameter Name="selectConnectionString" Type="System.String" />
  181. </Parameters>
  182. <Docs>
  183. <remarks>
  184. <attribution license="cc4" from="Microsoft" modified="false" />
  185. <para>This overload of the <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> constructor uses the <paramref name="selectConnectionString" /> parameter to set the <see cref="P:System.Data.Odbc.OdbcDataAdapter.SelectCommand" /> property. However, it does not open the connection. You still must explicitly open the connection.</para>
  186. </remarks>
  187. <summary>
  188. <attribution license="cc4" from="Microsoft" modified="false" />
  189. <para>Initializes a new instance of the <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> class with an SQL SELECT statement and a connection string.</para>
  190. </summary>
  191. <param name="selectCommandText">
  192. <attribution license="cc4" from="Microsoft" modified="false" />A string that is a SQL SELECT statement or stored procedure to be used by the <see cref="P:System.Data.Odbc.OdbcDataAdapter.SelectCommand" /> property of the <see cref="T:System.Data.Odbc.OdbcDataAdapter" />. </param>
  193. <param name="selectConnectionString">
  194. <attribution license="cc4" from="Microsoft" modified="false" />The connection string. </param>
  195. </Docs>
  196. <AssemblyInfo>
  197. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  198. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  199. </AssemblyInfo>
  200. </Member>
  201. <Member MemberName="CreateRowUpdatedEvent">
  202. <MemberSignature Language="C#" Value="protected override System.Data.Common.RowUpdatedEventArgs CreateRowUpdatedEvent (System.Data.DataRow dataRow, System.Data.IDbCommand command, System.Data.StatementType statementType, System.Data.Common.DataTableMapping tableMapping);" />
  203. <MemberType>Method</MemberType>
  204. <ReturnValue>
  205. <ReturnType>System.Data.Common.RowUpdatedEventArgs</ReturnType>
  206. </ReturnValue>
  207. <Parameters>
  208. <Parameter Name="dataRow" Type="System.Data.DataRow" />
  209. <Parameter Name="command" Type="System.Data.IDbCommand" />
  210. <Parameter Name="statementType" Type="System.Data.StatementType" />
  211. <Parameter Name="tableMapping" Type="System.Data.Common.DataTableMapping" />
  212. </Parameters>
  213. <Docs>
  214. <param name="dataRow">To be added.</param>
  215. <param name="command">To be added.</param>
  216. <param name="statementType">To be added.</param>
  217. <param name="tableMapping">To be added.</param>
  218. <summary>To be added.</summary>
  219. <returns>To be added.</returns>
  220. <remarks>To be added.</remarks>
  221. </Docs>
  222. <AssemblyInfo>
  223. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  224. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  225. </AssemblyInfo>
  226. </Member>
  227. <Member MemberName="CreateRowUpdatingEvent">
  228. <MemberSignature Language="C#" Value="protected override System.Data.Common.RowUpdatingEventArgs CreateRowUpdatingEvent (System.Data.DataRow dataRow, System.Data.IDbCommand command, System.Data.StatementType statementType, System.Data.Common.DataTableMapping tableMapping);" />
  229. <MemberType>Method</MemberType>
  230. <ReturnValue>
  231. <ReturnType>System.Data.Common.RowUpdatingEventArgs</ReturnType>
  232. </ReturnValue>
  233. <Parameters>
  234. <Parameter Name="dataRow" Type="System.Data.DataRow" />
  235. <Parameter Name="command" Type="System.Data.IDbCommand" />
  236. <Parameter Name="statementType" Type="System.Data.StatementType" />
  237. <Parameter Name="tableMapping" Type="System.Data.Common.DataTableMapping" />
  238. </Parameters>
  239. <Docs>
  240. <param name="dataRow">To be added.</param>
  241. <param name="command">To be added.</param>
  242. <param name="statementType">To be added.</param>
  243. <param name="tableMapping">To be added.</param>
  244. <summary>To be added.</summary>
  245. <returns>To be added.</returns>
  246. <remarks>To be added.</remarks>
  247. </Docs>
  248. <AssemblyInfo>
  249. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  250. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  251. </AssemblyInfo>
  252. </Member>
  253. <Member MemberName="DeleteCommand">
  254. <MemberSignature Language="C#" Value="public System.Data.Odbc.OdbcCommand DeleteCommand { set; get; }" />
  255. <MemberType>Property</MemberType>
  256. <Attributes>
  257. <Attribute>
  258. <AttributeName>System.ComponentModel.Editor("Microsoft.VSDesigner.Data.Design.DBCommandEditor, Microsoft.VSDesigner, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
  259. </Attribute>
  260. <Attribute>
  261. <AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName>
  262. </Attribute>
  263. </Attributes>
  264. <ReturnValue>
  265. <ReturnType>System.Data.Odbc.OdbcCommand</ReturnType>
  266. </ReturnValue>
  267. <Docs>
  268. <value>To be added.</value>
  269. <remarks>
  270. <attribution license="cc4" from="Microsoft" modified="false" />
  271. <para>When the <see cref="P:System.Data.Odbc.OdbcDataAdapter.DeleteCommand" /> property is assigned to a previously created <see cref="T:System.Data.Odbc.OdbcCommand" />, the <see cref="T:System.Data.Odbc.OdbcCommand" /> is not cloned. Instead, the <see cref="P:System.Data.Odbc.OdbcDataAdapter.DeleteCommand" /> maintains a reference to the previously created <see cref="T:System.Data.Odbc.OdbcCommand" />.</para>
  272. <para>During an update operation, if <see cref="P:System.Data.Odbc.OdbcDataAdapter.DeleteCommand" /> is not set and primary key information is present in the <see cref="T:System.Data.DataSet" />, you can use the <see cref="T:System.Data.Odbc.OdbcCommandBuilder" /> class to automatically generate the <see cref="P:System.Data.Odbc.OdbcDataAdapter.DeleteCommand" />, and additional commands needed to reconcile the <see cref="T:System.Data.DataSet" /> to the data source. To do this, set the <see cref="P:System.Data.Odbc.OdbcDataAdapter.SelectCommand" /> property of the <see cref="T:System.Data.Odbc.OdbcDataAdapter" />. The generation logic also 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 Generating Commands</a></format>.</para>
  273. </remarks>
  274. <summary>
  275. <attribution license="cc4" from="Microsoft" modified="false" />
  276. <para>Gets or sets an SQL statement or stored procedure used to delete records in the data source.</para>
  277. </summary>
  278. </Docs>
  279. <AssemblyInfo>
  280. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  281. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  282. </AssemblyInfo>
  283. </Member>
  284. <Member MemberName="Dispose">
  285. <MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
  286. <MemberType>Method</MemberType>
  287. <ReturnValue>
  288. <ReturnType>System.Void</ReturnType>
  289. </ReturnValue>
  290. <Parameters>
  291. <Parameter Name="disposing" Type="System.Boolean" />
  292. </Parameters>
  293. <Docs>
  294. <param name="disposing">To be added.</param>
  295. <summary>To be added.</summary>
  296. <remarks>To be added.</remarks>
  297. </Docs>
  298. <AssemblyInfo>
  299. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  300. </AssemblyInfo>
  301. </Member>
  302. <Member MemberName="InsertCommand">
  303. <MemberSignature Language="C#" Value="public System.Data.Odbc.OdbcCommand InsertCommand { set; get; }" />
  304. <MemberType>Property</MemberType>
  305. <Attributes>
  306. <Attribute>
  307. <AttributeName>System.ComponentModel.Editor("Microsoft.VSDesigner.Data.Design.DBCommandEditor, Microsoft.VSDesigner, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
  308. </Attribute>
  309. <Attribute>
  310. <AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName>
  311. </Attribute>
  312. </Attributes>
  313. <ReturnValue>
  314. <ReturnType>System.Data.Odbc.OdbcCommand</ReturnType>
  315. </ReturnValue>
  316. <Docs>
  317. <value>To be added.</value>
  318. <remarks>
  319. <attribution license="cc4" from="Microsoft" modified="false" />
  320. <para>When the <see cref="P:System.Data.Odbc.OdbcDataAdapter.InsertCommand" /> property is assigned to a previously created <see cref="T:System.Data.Odbc.OdbcCommand" /> object, the <see cref="T:System.Data.Odbc.OdbcCommand" /> is not cloned. Instead, <see cref="P:System.Data.Odbc.OdbcDataAdapter.InsertCommand" /> maintains a reference to the previously created <see cref="T:System.Data.Odbc.OdbcCommand" />.</para>
  321. <para>During an update operation, if <see cref="P:System.Data.Odbc.OdbcDataAdapter.InsertCommand" /> is not set and primary key information is present in the <see cref="T:System.Data.DataSet" />, you can use the <see cref="T:System.Data.Odbc.OdbcCommandBuilder" /> class to automatically generate <see cref="P:System.Data.Odbc.OdbcDataAdapter.InsertCommand" />, and additional commands needed to reconcile the <see cref="T:System.Data.DataSet" /> to the data source. To do this, set the <see cref="P:System.Data.Odbc.OdbcDataAdapter.SelectCommand" /> property of the <see cref="T:System.Data.Odbc.OdbcDataAdapter" />. The generation logic also 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 Generating Commands</a></format>.</para>
  322. <block subset="none" type="note">
  323. <para>If execution of this command returns rows, these rows may be added to the <see cref="T:System.Data.DataSet" /> depending upon how you set the <see cref="!:System.Data.Odbc.OdbcCommand.UpdatedRowSource" /> property of the <see cref="T:System.Data.Odbc.OdbcCommand" /> object.</para>
  324. </block>
  325. </remarks>
  326. <summary>
  327. <attribution license="cc4" from="Microsoft" modified="false" />
  328. <para>Gets or sets an SQL statement or stored procedure used to insert new records into the data source.</para>
  329. </summary>
  330. </Docs>
  331. <AssemblyInfo>
  332. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  333. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  334. </AssemblyInfo>
  335. </Member>
  336. <Member MemberName="OnRowUpdated">
  337. <MemberSignature Language="C#" Value="protected override void OnRowUpdated (System.Data.Common.RowUpdatedEventArgs value);" />
  338. <MemberType>Method</MemberType>
  339. <ReturnValue>
  340. <ReturnType>System.Void</ReturnType>
  341. </ReturnValue>
  342. <Parameters>
  343. <Parameter Name="value" Type="System.Data.Common.RowUpdatedEventArgs" />
  344. </Parameters>
  345. <Docs>
  346. <param name="value">To be added.</param>
  347. <summary>To be added.</summary>
  348. <remarks>To be added.</remarks>
  349. </Docs>
  350. <AssemblyInfo>
  351. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  352. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  353. </AssemblyInfo>
  354. </Member>
  355. <Member MemberName="OnRowUpdating">
  356. <MemberSignature Language="C#" Value="protected override void OnRowUpdating (System.Data.Common.RowUpdatingEventArgs value);" />
  357. <MemberType>Method</MemberType>
  358. <ReturnValue>
  359. <ReturnType>System.Void</ReturnType>
  360. </ReturnValue>
  361. <Parameters>
  362. <Parameter Name="value" Type="System.Data.Common.RowUpdatingEventArgs" />
  363. </Parameters>
  364. <Docs>
  365. <param name="value">To be added.</param>
  366. <summary>To be added.</summary>
  367. <remarks>To be added.</remarks>
  368. </Docs>
  369. <AssemblyInfo>
  370. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  371. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  372. </AssemblyInfo>
  373. </Member>
  374. <Member MemberName="RowUpdated">
  375. <MemberSignature Language="C#" Value="public event System.Data.Odbc.OdbcRowUpdatedEventHandler RowUpdated;" />
  376. <MemberType>Event</MemberType>
  377. <ReturnValue>
  378. <ReturnType>System.Data.Odbc.OdbcRowUpdatedEventHandler</ReturnType>
  379. </ReturnValue>
  380. <Docs>
  381. <remarks>
  382. <attribution license="cc4" from="Microsoft" modified="false" />
  383. <para>When you use <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />, there are two events that occur per data row updated. The order of execution is as follows: </para>
  384. <list type="ordered">
  385. <item>
  386. <para>The values in the <see cref="T:System.Data.DataRow" /> are moved to the parameter values.</para>
  387. </item>
  388. <item>
  389. <para>The <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdating(System.Data.Common.RowUpdatingEventArgs)" /> event is raised.</para>
  390. </item>
  391. <item>
  392. <para>The command executes.</para>
  393. </item>
  394. <item>
  395. <para>If the command is set to FirstReturnedRecord, the first returned result is placed in the <see cref="T:System.Data.DataRow" />.</para>
  396. </item>
  397. <item>
  398. <para>If there are output parameters, they are placed in the <see cref="T:System.Data.DataRow" />.</para>
  399. </item>
  400. <item>
  401. <para>The <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)" /> event is raised.</para>
  402. </item>
  403. <item>
  404. <para>
  405. <see cref="M:System.Data.DataRow.AcceptChanges" /> is called.</para>
  406. </item>
  407. </list>
  408. </remarks>
  409. <summary>
  410. <attribution license="cc4" from="Microsoft" modified="false" />
  411. <para>Occurs during an update operation after a command is executed against the data source.</para>
  412. </summary>
  413. </Docs>
  414. <AssemblyInfo>
  415. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  416. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  417. </AssemblyInfo>
  418. </Member>
  419. <Member MemberName="RowUpdating">
  420. <MemberSignature Language="C#" Value="public event System.Data.Odbc.OdbcRowUpdatingEventHandler RowUpdating;" />
  421. <MemberType>Event</MemberType>
  422. <ReturnValue>
  423. <ReturnType>System.Data.Odbc.OdbcRowUpdatingEventHandler</ReturnType>
  424. </ReturnValue>
  425. <Docs>
  426. <remarks>
  427. <attribution license="cc4" from="Microsoft" modified="false" />
  428. <para>When you use <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />, there are two events that occur per data row updated. The order of execution is as follows: </para>
  429. <list type="ordered">
  430. <item>
  431. <para>The values in the <see cref="T:System.Data.DataRow" /> are moved to the parameter values.</para>
  432. </item>
  433. <item>
  434. <para>The <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdating(System.Data.Common.RowUpdatingEventArgs)" /> event is raised.</para>
  435. </item>
  436. <item>
  437. <para>The command executes.</para>
  438. </item>
  439. <item>
  440. <para>If the command is set to FirstReturnedRecord, the first returned result is placed in the <see cref="T:System.Data.DataRow" />.</para>
  441. </item>
  442. <item>
  443. <para>If there are output parameters, they are placed in the <see cref="T:System.Data.DataRow" />.</para>
  444. </item>
  445. <item>
  446. <para>The <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)" /> event is raised.</para>
  447. </item>
  448. <item>
  449. <para>
  450. <see cref="M:System.Data.DataRow.AcceptChanges" /> is called.</para>
  451. </item>
  452. </list>
  453. </remarks>
  454. <summary>
  455. <attribution license="cc4" from="Microsoft" modified="false" />
  456. <para>Occurs during <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> before a command is executed against the data source.</para>
  457. </summary>
  458. </Docs>
  459. <AssemblyInfo>
  460. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  461. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  462. </AssemblyInfo>
  463. </Member>
  464. <Member MemberName="SelectCommand">
  465. <MemberSignature Language="C#" Value="public System.Data.Odbc.OdbcCommand SelectCommand { set; get; }" />
  466. <MemberType>Property</MemberType>
  467. <Attributes>
  468. <Attribute>
  469. <AttributeName>System.ComponentModel.Editor("Microsoft.VSDesigner.Data.Design.DBCommandEditor, Microsoft.VSDesigner, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
  470. </Attribute>
  471. <Attribute>
  472. <AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName>
  473. </Attribute>
  474. </Attributes>
  475. <ReturnValue>
  476. <ReturnType>System.Data.Odbc.OdbcCommand</ReturnType>
  477. </ReturnValue>
  478. <Docs>
  479. <value>To be added.</value>
  480. <remarks>
  481. <attribution license="cc4" from="Microsoft" modified="false" />
  482. <para>When <see cref="P:System.Data.Odbc.OdbcDataAdapter.SelectCommand" /> is assigned to a previously created <see cref="T:System.Data.Odbc.OdbcCommand" />, the <see cref="T:System.Data.Odbc.OdbcCommand" /> is not cloned. Instead, the <see cref="P:System.Data.Odbc.OdbcDataAdapter.SelectCommand" /> maintains a reference to the previously created <see cref="T:System.Data.Odbc.OdbcCommand" /> object.</para>
  483. <para>If <see cref="P:System.Data.Odbc.OdbcDataAdapter.SelectCommand" /> returns no rows, no tables are added to the <see cref="T:System.Data.DataSet" />, and no exception is raised.</para>
  484. </remarks>
  485. <summary>
  486. <attribution license="cc4" from="Microsoft" modified="false" />
  487. <para>Gets or sets an SQL statement or stored procedure used to select records in the data source.</para>
  488. </summary>
  489. </Docs>
  490. <AssemblyInfo>
  491. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  492. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  493. </AssemblyInfo>
  494. </Member>
  495. <Member MemberName="System.Data.IDataAdapter.TableMappings">
  496. <MemberSignature Language="C#" Value="System.Data.ITableMappingCollection System.Data.IDataAdapter.TableMappings { get; }" />
  497. <MemberType>Property</MemberType>
  498. <AssemblyInfo>
  499. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  500. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  501. </AssemblyInfo>
  502. <ReturnValue>
  503. <ReturnType>System.Data.ITableMappingCollection</ReturnType>
  504. </ReturnValue>
  505. <Docs>
  506. <summary>To be added.</summary>
  507. <value>To be added.</value>
  508. <remarks>To be added.</remarks>
  509. </Docs>
  510. </Member>
  511. <Member MemberName="System.Data.IDbDataAdapter.DeleteCommand">
  512. <MemberSignature Language="C#" Value="System.Data.IDbCommand System.Data.IDbDataAdapter.DeleteCommand { set; get; }" />
  513. <MemberType>Property</MemberType>
  514. <AssemblyInfo>
  515. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  516. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  517. </AssemblyInfo>
  518. <ReturnValue>
  519. <ReturnType>System.Data.IDbCommand</ReturnType>
  520. </ReturnValue>
  521. <Docs>
  522. <value>To be added.</value>
  523. <remarks>
  524. <attribution license="cc4" from="Microsoft" modified="false" />
  525. <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> instance is cast to an <see cref="T:System.Data.IDbDataAdapter" /> interface.</para>
  526. </remarks>
  527. <summary>
  528. <attribution license="cc4" from="Microsoft" modified="false" />
  529. <para>For a description of this member, see <see cref="M:System.Data.IDbDataAdapter.DeleteCommand" />.</para>
  530. </summary>
  531. </Docs>
  532. </Member>
  533. <Member MemberName="System.Data.IDbDataAdapter.InsertCommand">
  534. <MemberSignature Language="C#" Value="System.Data.IDbCommand System.Data.IDbDataAdapter.InsertCommand { set; get; }" />
  535. <MemberType>Property</MemberType>
  536. <AssemblyInfo>
  537. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  538. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  539. </AssemblyInfo>
  540. <ReturnValue>
  541. <ReturnType>System.Data.IDbCommand</ReturnType>
  542. </ReturnValue>
  543. <Docs>
  544. <value>To be added.</value>
  545. <remarks>
  546. <attribution license="cc4" from="Microsoft" modified="false" />
  547. <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> instance is cast to an <see cref="T:System.Data.IDbDataAdapter" /> interface.</para>
  548. </remarks>
  549. <summary>
  550. <attribution license="cc4" from="Microsoft" modified="false" />
  551. <para>For a description of this member, see <see cref="M:System.Data.IDbDataAdapter.InsertCommand" />.</para>
  552. </summary>
  553. </Docs>
  554. </Member>
  555. <Member MemberName="System.Data.IDbDataAdapter.SelectCommand">
  556. <MemberSignature Language="C#" Value="System.Data.IDbCommand System.Data.IDbDataAdapter.SelectCommand { set; get; }" />
  557. <MemberType>Property</MemberType>
  558. <AssemblyInfo>
  559. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  560. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  561. </AssemblyInfo>
  562. <ReturnValue>
  563. <ReturnType>System.Data.IDbCommand</ReturnType>
  564. </ReturnValue>
  565. <Docs>
  566. <value>To be added.</value>
  567. <remarks>
  568. <attribution license="cc4" from="Microsoft" modified="false" />
  569. <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> instance is cast to an <see cref="T:System.Data.IDbDataAdapter" /> interface.</para>
  570. </remarks>
  571. <summary>
  572. <attribution license="cc4" from="Microsoft" modified="false" />
  573. <para>For a description of this member, see <see cref="M:System.Data.IDbDataAdapter.SelectCommand" />.</para>
  574. </summary>
  575. </Docs>
  576. </Member>
  577. <Member MemberName="System.Data.IDbDataAdapter.UpdateCommand">
  578. <MemberSignature Language="C#" Value="System.Data.IDbCommand System.Data.IDbDataAdapter.UpdateCommand { set; get; }" />
  579. <MemberType>Property</MemberType>
  580. <AssemblyInfo>
  581. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  582. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  583. </AssemblyInfo>
  584. <ReturnValue>
  585. <ReturnType>System.Data.IDbCommand</ReturnType>
  586. </ReturnValue>
  587. <Docs>
  588. <value>To be added.</value>
  589. <remarks>
  590. <attribution license="cc4" from="Microsoft" modified="false" />
  591. <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> instance is cast to an <see cref="T:System.Data.IDbDataAdapter" /> interface.</para>
  592. </remarks>
  593. <summary>
  594. <attribution license="cc4" from="Microsoft" modified="false" />
  595. <para>For a description of this member, see <see cref="M:System.Data.IDbDataAdapter.UpdateCommand" />.</para>
  596. </summary>
  597. </Docs>
  598. </Member>
  599. <Member MemberName="System.ICloneable.Clone">
  600. <MemberSignature Language="C#" Value="object ICloneable.Clone ();" />
  601. <MemberType>Method</MemberType>
  602. <AssemblyInfo>
  603. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  604. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  605. </AssemblyInfo>
  606. <ReturnValue>
  607. <ReturnType>System.Object</ReturnType>
  608. </ReturnValue>
  609. <Parameters />
  610. <Docs>
  611. <remarks>
  612. <attribution license="cc4" from="Microsoft" modified="false" />
  613. <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.Odbc.OdbcDataAdapter" /> instance is cast to an <see cref="T:System.ICloneable" /> interface.</para>
  614. </remarks>
  615. <summary>
  616. <attribution license="cc4" from="Microsoft" modified="false" />
  617. <para>For a description of this member, see <see cref="M:System.ICloneable.Clone" />.</para>
  618. </summary>
  619. <returns>
  620. <attribution license="cc4" from="Microsoft" modified="false" />
  621. <para>A new <see cref="T:System.Object" /> that is a copy of this instance.</para>
  622. </returns>
  623. </Docs>
  624. </Member>
  625. <Member MemberName="UpdateCommand">
  626. <MemberSignature Language="C#" Value="public System.Data.Odbc.OdbcCommand UpdateCommand { set; get; }" />
  627. <MemberType>Property</MemberType>
  628. <Attributes>
  629. <Attribute>
  630. <AttributeName>System.ComponentModel.Editor("Microsoft.VSDesigner.Data.Design.DBCommandEditor, Microsoft.VSDesigner, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
  631. </Attribute>
  632. <Attribute>
  633. <AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName>
  634. </Attribute>
  635. </Attributes>
  636. <ReturnValue>
  637. <ReturnType>System.Data.Odbc.OdbcCommand</ReturnType>
  638. </ReturnValue>
  639. <Docs>
  640. <value>To be added.</value>
  641. <remarks>
  642. <attribution license="cc4" from="Microsoft" modified="false" />
  643. <para>When <see cref="P:System.Data.Odbc.OdbcDataAdapter.UpdateCommand" /> is assigned to a previously created <see cref="T:System.Data.Odbc.OdbcCommand" />, the <see cref="T:System.Data.Odbc.OdbcCommand" /> is not cloned. Instead, the <see cref="P:System.Data.Odbc.OdbcDataAdapter.UpdateCommand" /> maintains a reference to the previously created <see cref="T:System.Data.Odbc.OdbcCommand" /> object.</para>
  644. <para>During an update operation, if <see cref="P:System.Data.Odbc.OdbcDataAdapter.UpdateCommand" /> is not set and primary key information is present in the <see cref="T:System.Data.DataSet" />, you can use the <see cref="T:System.Data.Odbc.OdbcCommandBuilder" /> class to automatically generate <see cref="P:System.Data.Odbc.OdbcDataAdapter.UpdateCommand" />, and additional commands needed to reconcile the <see cref="T:System.Data.DataSet" /> to the data source. To do this, set the <see cref="P:System.Data.Odbc.OdbcDataAdapter.SelectCommand" /> property of the <see cref="T:System.Data.Odbc.OdbcDataAdapter" />. The generation logic also 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 Generating Commands</a></format>.</para>
  645. <block subset="none" type="note">
  646. <para>If execution of this command returns rows, these rows may be merged with the <see cref="T:System.Data.DataSet" /> depending upon how you set the <see cref="!:System.Data.Odbc.OdbcCommand.UpdatedRowSource" /> property of the <see cref="T:System.Data.Odbc.OdbcCommand" /> object.</para>
  647. </block>
  648. </remarks>
  649. <summary>
  650. <attribution license="cc4" from="Microsoft" modified="false" />
  651. <para>Gets or sets an SQL statement or stored procedure used to update records in the data source.</para>
  652. </summary>
  653. </Docs>
  654. <AssemblyInfo>
  655. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  656. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  657. </AssemblyInfo>
  658. </Member>
  659. </Members>
  660. </Type>