DbCommand.xml 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <Type Name="DbCommand" FullName="System.Data.Common.DbCommand">
  3. <TypeSignature Language="C#" Value="public abstract class DbCommand : System.ComponentModel.Component, System.Data.IDbCommand" />
  4. <AssemblyInfo>
  5. <AssemblyName>System.Data</AssemblyName>
  6. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>System.ComponentModel.Component</BaseTypeName>
  10. </Base>
  11. <Interfaces>
  12. <Interface>
  13. <InterfaceName>System.Data.IDbCommand</InterfaceName>
  14. </Interface>
  15. </Interfaces>
  16. <Docs>
  17. <remarks>To be added.</remarks>
  18. <since version=".NET 2.0" />
  19. <summary>
  20. <attribution license="cc4" from="Microsoft" modified="false" />
  21. <para>Represents an SQL statement or stored procedure to execute against a data source. Provides a base class for database-specific classes that represent commands. <see cref="Overload:System.Data.Common.DbCommand.ExecuteNonQueryAsync" /></para>
  22. </summary>
  23. </Docs>
  24. <Members>
  25. <Member MemberName=".ctor">
  26. <MemberSignature Language="C#" Value="protected DbCommand ();" />
  27. <MemberType>Constructor</MemberType>
  28. <Parameters />
  29. <Docs>
  30. <remarks>To be added.</remarks>
  31. <since version=".NET 2.0" />
  32. <summary>
  33. <attribution license="cc4" from="Microsoft" modified="false" />
  34. <para>Constructs an instance of the <see cref="T:System.Data.Common.DbCommand" /> object.</para>
  35. </summary>
  36. </Docs>
  37. <AssemblyInfo>
  38. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  39. </AssemblyInfo>
  40. </Member>
  41. <Member MemberName="Cancel">
  42. <MemberSignature Language="C#" Value="public abstract void Cancel ();" />
  43. <MemberType>Method</MemberType>
  44. <ReturnValue>
  45. <ReturnType>System.Void</ReturnType>
  46. </ReturnValue>
  47. <Parameters />
  48. <Docs>
  49. <since version=".NET 2.0" />
  50. <remarks>
  51. <attribution license="cc4" from="Microsoft" modified="false" />
  52. <para>If there is nothing to cancel, nothing happens. However, if there is a command in process, and the attempt to cancel fails, no exception is generated.</para>
  53. </remarks>
  54. <summary>
  55. <attribution license="cc4" from="Microsoft" modified="false" />
  56. <para>Attempts to cancels the execution of a <see cref="T:System.Data.Common.DbCommand" />.</para>
  57. </summary>
  58. </Docs>
  59. <AssemblyInfo>
  60. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  61. </AssemblyInfo>
  62. </Member>
  63. <Member MemberName="CommandText">
  64. <MemberSignature Language="C#" Value="public abstract string CommandText { set; get; }" />
  65. <MemberType>Property</MemberType>
  66. <Attributes>
  67. <Attribute>
  68. <AttributeName>System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.All)</AttributeName>
  69. </Attribute>
  70. <Attribute>
  71. <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
  72. </Attribute>
  73. </Attributes>
  74. <ReturnValue>
  75. <ReturnType>System.String</ReturnType>
  76. </ReturnValue>
  77. <Docs>
  78. <value>To be added.</value>
  79. <since version=".NET 2.0" />
  80. <remarks>
  81. <attribution license="cc4" from="Microsoft" modified="false" />
  82. <para>When you set the <see cref="T:System.Data.CommandType" /> to StoredProcedure, you should set the <see cref="P:System.Data.Common.DbCommand.CommandText" /> property to the name of the stored procedure. The command executes this stored procedure when you call one of the Execute methods.</para>
  83. </remarks>
  84. <summary>
  85. <attribution license="cc4" from="Microsoft" modified="false" />
  86. <para>Gets or sets the text command to run against the data source.</para>
  87. </summary>
  88. </Docs>
  89. <AssemblyInfo>
  90. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  91. </AssemblyInfo>
  92. </Member>
  93. <Member MemberName="CommandTimeout">
  94. <MemberSignature Language="C#" Value="public abstract int CommandTimeout { set; get; }" />
  95. <MemberType>Property</MemberType>
  96. <ReturnValue>
  97. <ReturnType>System.Int32</ReturnType>
  98. </ReturnValue>
  99. <Docs>
  100. <value>To be added.</value>
  101. <since version=".NET 2.0" />
  102. <remarks>
  103. <attribution license="cc4" from="Microsoft" modified="false" />
  104. <para>An <see cref="T:System.ArgumentException" /> is generated if the assigned <see cref="P:System.Data.Common.DbCommand.CommandTimeout" /> property value is less than 0.</para>
  105. <para>Note to implementers, it is recommended that 0 means no timeout.</para>
  106. </remarks>
  107. <summary>
  108. <attribution license="cc4" from="Microsoft" modified="false" />
  109. <para>Gets or sets the wait time before terminating the attempt to execute a command and generating an error.</para>
  110. </summary>
  111. </Docs>
  112. <AssemblyInfo>
  113. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  114. </AssemblyInfo>
  115. </Member>
  116. <Member MemberName="CommandType">
  117. <MemberSignature Language="C#" Value="public abstract System.Data.CommandType CommandType { set; get; }" />
  118. <MemberType>Property</MemberType>
  119. <Attributes>
  120. <Attribute>
  121. <AttributeName>System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.All)</AttributeName>
  122. </Attribute>
  123. <Attribute>
  124. <AttributeName>System.ComponentModel.DefaultValue(System.Data.CommandType.Text)</AttributeName>
  125. </Attribute>
  126. </Attributes>
  127. <ReturnValue>
  128. <ReturnType>System.Data.CommandType</ReturnType>
  129. </ReturnValue>
  130. <Docs>
  131. <value>To be added.</value>
  132. <since version=".NET 2.0" />
  133. <remarks>
  134. <attribution license="cc4" from="Microsoft" modified="false" />
  135. <para>When you set the <see cref="T:System.Data.CommandType" /> to StoredProcedure, you should set the <see cref="P:System.Data.Common.DbCommand.CommandText" /> property to the name of the stored procedure. The command executes this stored procedure when you call one of the Execute methods.</para>
  136. </remarks>
  137. <summary>
  138. <attribution license="cc4" from="Microsoft" modified="false" />
  139. <para>Indicates or specifies how the <see cref="P:System.Data.Common.DbCommand.CommandText" /> property is interpreted.</para>
  140. </summary>
  141. </Docs>
  142. <AssemblyInfo>
  143. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  144. </AssemblyInfo>
  145. </Member>
  146. <Member MemberName="Connection">
  147. <MemberSignature Language="C#" Value="public System.Data.Common.DbConnection Connection { set; get; }" />
  148. <MemberType>Property</MemberType>
  149. <Attributes>
  150. <Attribute>
  151. <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
  152. </Attribute>
  153. <Attribute>
  154. <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
  155. </Attribute>
  156. <Attribute>
  157. <AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName>
  158. </Attribute>
  159. </Attributes>
  160. <ReturnValue>
  161. <ReturnType>System.Data.Common.DbConnection</ReturnType>
  162. </ReturnValue>
  163. <Docs>
  164. <value>To be added.</value>
  165. <remarks>To be added.</remarks>
  166. <since version=".NET 2.0" />
  167. <summary>
  168. <attribution license="cc4" from="Microsoft" modified="false" />
  169. <para>Gets or sets the <see cref="T:System.Data.Common.DbConnection" /> used by this <see cref="T:System.Data.Common.DbCommand" />.</para>
  170. </summary>
  171. </Docs>
  172. <AssemblyInfo>
  173. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  174. </AssemblyInfo>
  175. </Member>
  176. <Member MemberName="CreateDbParameter">
  177. <MemberSignature Language="C#" Value="protected abstract System.Data.Common.DbParameter CreateDbParameter ();" />
  178. <MemberType>Method</MemberType>
  179. <ReturnValue>
  180. <ReturnType>System.Data.Common.DbParameter</ReturnType>
  181. </ReturnValue>
  182. <Parameters />
  183. <Docs>
  184. <remarks>To be added.</remarks>
  185. <since version=".NET 2.0" />
  186. <summary>
  187. <attribution license="cc4" from="Microsoft" modified="false" />
  188. <para>Creates a new instance of a <see cref="T:System.Data.Common.DbParameter" /> object.</para>
  189. </summary>
  190. <returns>
  191. <attribution license="cc4" from="Microsoft" modified="false" />
  192. <para>A <see cref="T:System.Data.Common.DbParameter" /> object.</para>
  193. </returns>
  194. </Docs>
  195. <AssemblyInfo>
  196. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  197. </AssemblyInfo>
  198. </Member>
  199. <Member MemberName="CreateParameter">
  200. <MemberSignature Language="C#" Value="public System.Data.Common.DbParameter CreateParameter ();" />
  201. <MemberType>Method</MemberType>
  202. <ReturnValue>
  203. <ReturnType>System.Data.Common.DbParameter</ReturnType>
  204. </ReturnValue>
  205. <Parameters />
  206. <Docs>
  207. <remarks>To be added.</remarks>
  208. <since version=".NET 2.0" />
  209. <summary>
  210. <attribution license="cc4" from="Microsoft" modified="false" />
  211. <para>Creates a new instance of a <see cref="T:System.Data.Common.DbParameter" /> object.</para>
  212. </summary>
  213. <returns>
  214. <attribution license="cc4" from="Microsoft" modified="false" />
  215. <para>A <see cref="T:System.Data.Common.DbParameter" /> object.</para>
  216. </returns>
  217. </Docs>
  218. <AssemblyInfo>
  219. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  220. </AssemblyInfo>
  221. </Member>
  222. <Member MemberName="DbConnection">
  223. <MemberSignature Language="C#" Value="protected abstract System.Data.Common.DbConnection DbConnection { set; get; }" />
  224. <MemberType>Property</MemberType>
  225. <ReturnValue>
  226. <ReturnType>System.Data.Common.DbConnection</ReturnType>
  227. </ReturnValue>
  228. <Docs>
  229. <value>To be added.</value>
  230. <remarks>To be added.</remarks>
  231. <since version=".NET 2.0" />
  232. <summary>
  233. <attribution license="cc4" from="Microsoft" modified="false" />
  234. <para>Gets or sets the <see cref="T:System.Data.Common.DbConnection" /> used by this <see cref="T:System.Data.Common.DbCommand" />.</para>
  235. </summary>
  236. </Docs>
  237. <AssemblyInfo>
  238. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  239. </AssemblyInfo>
  240. </Member>
  241. <Member MemberName="DbParameterCollection">
  242. <MemberSignature Language="C#" Value="protected abstract System.Data.Common.DbParameterCollection DbParameterCollection { get; }" />
  243. <MemberType>Property</MemberType>
  244. <ReturnValue>
  245. <ReturnType>System.Data.Common.DbParameterCollection</ReturnType>
  246. </ReturnValue>
  247. <Docs>
  248. <value>To be added.</value>
  249. <remarks>To be added.</remarks>
  250. <since version=".NET 2.0" />
  251. <summary>
  252. <attribution license="cc4" from="Microsoft" modified="false" />
  253. <para>Gets the collection of <see cref="T:System.Data.Common.DbParameter" /> objects.</para>
  254. </summary>
  255. </Docs>
  256. <AssemblyInfo>
  257. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  258. </AssemblyInfo>
  259. </Member>
  260. <Member MemberName="DbTransaction">
  261. <MemberSignature Language="C#" Value="protected abstract System.Data.Common.DbTransaction DbTransaction { set; get; }" />
  262. <MemberType>Property</MemberType>
  263. <ReturnValue>
  264. <ReturnType>System.Data.Common.DbTransaction</ReturnType>
  265. </ReturnValue>
  266. <Docs>
  267. <value>To be added.</value>
  268. <remarks>To be added.</remarks>
  269. <since version=".NET 2.0" />
  270. <summary>
  271. <attribution license="cc4" from="Microsoft" modified="false" />
  272. <para>Gets or sets the <see cref="P:System.Data.Common.DbCommand.DbTransaction" /> within which this <see cref="T:System.Data.Common.DbCommand" /> object executes.</para>
  273. </summary>
  274. </Docs>
  275. <AssemblyInfo>
  276. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  277. </AssemblyInfo>
  278. </Member>
  279. <Member MemberName="DesignTimeVisible">
  280. <MemberSignature Language="C#" Value="public abstract bool DesignTimeVisible { set; get; }" />
  281. <MemberType>Property</MemberType>
  282. <Attributes>
  283. <Attribute>
  284. <AttributeName>System.ComponentModel.DesignOnly(true)</AttributeName>
  285. </Attribute>
  286. <Attribute>
  287. <AttributeName>System.ComponentModel.DefaultValue(true)</AttributeName>
  288. </Attribute>
  289. <Attribute>
  290. <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
  291. </Attribute>
  292. <Attribute>
  293. <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
  294. </Attribute>
  295. </Attributes>
  296. <ReturnValue>
  297. <ReturnType>System.Boolean</ReturnType>
  298. </ReturnValue>
  299. <Docs>
  300. <value>To be added.</value>
  301. <remarks>To be added.</remarks>
  302. <since version=".NET 2.0" />
  303. <summary>
  304. <attribution license="cc4" from="Microsoft" modified="false" />
  305. <para>Gets or sets a value indicating whether the command object should be visible in a customized interface control.</para>
  306. </summary>
  307. </Docs>
  308. <AssemblyInfo>
  309. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  310. </AssemblyInfo>
  311. </Member>
  312. <Member MemberName="ExecuteDbDataReader">
  313. <MemberSignature Language="C#" Value="protected abstract System.Data.Common.DbDataReader ExecuteDbDataReader (System.Data.CommandBehavior behavior);" />
  314. <MemberType>Method</MemberType>
  315. <ReturnValue>
  316. <ReturnType>System.Data.Common.DbDataReader</ReturnType>
  317. </ReturnValue>
  318. <Parameters>
  319. <Parameter Name="behavior" Type="System.Data.CommandBehavior" />
  320. </Parameters>
  321. <Docs>
  322. <remarks>To be added.</remarks>
  323. <since version=".NET 2.0" />
  324. <summary>
  325. <attribution license="cc4" from="Microsoft" modified="false" />
  326. <para>Executes the command text against the connection.</para>
  327. </summary>
  328. <returns>
  329. <attribution license="cc4" from="Microsoft" modified="false" />
  330. <para>A task representing the operation.</para>
  331. </returns>
  332. <param name="behavior">
  333. <attribution license="cc4" from="Microsoft" modified="false" />An instance of <see cref="T:System.Data.CommandBehavior" />.</param>
  334. </Docs>
  335. <AssemblyInfo>
  336. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  337. </AssemblyInfo>
  338. </Member>
  339. <Member MemberName="ExecuteNonQuery">
  340. <MemberSignature Language="C#" Value="public abstract int ExecuteNonQuery ();" />
  341. <MemberType>Method</MemberType>
  342. <ReturnValue>
  343. <ReturnType>System.Int32</ReturnType>
  344. </ReturnValue>
  345. <Parameters />
  346. <Docs>
  347. <since version=".NET 2.0" />
  348. <remarks>
  349. <attribution license="cc4" from="Microsoft" modified="false" />
  350. <para>You can use <see cref="M:System.Data.Common.DbCommand.ExecuteNonQuery" /> to perform catalog operations (for example, querying the structure of a database or creating database objects such as tables), or to change the data in a database by executing UPDATE, INSERT, or DELETE statements.</para>
  351. <para>Although <see cref="M:System.Data.Common.DbCommand.ExecuteNonQuery" /> does not return any rows, any output parameters or return values mapped to parameters are populated with data.</para>
  352. <para>For UPDATE, INSERT, and DELETE statements, the return value is the number of rows affected by the command. For all other types of statements, the return value is -1.</para>
  353. </remarks>
  354. <summary>
  355. <attribution license="cc4" from="Microsoft" modified="false" />
  356. <para>Executes a SQL statement against a connection object.</para>
  357. </summary>
  358. <returns>
  359. <attribution license="cc4" from="Microsoft" modified="false" />
  360. <para>The number of rows affected.</para>
  361. </returns>
  362. </Docs>
  363. <AssemblyInfo>
  364. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  365. </AssemblyInfo>
  366. </Member>
  367. <Member MemberName="ExecuteReader">
  368. <MemberSignature Language="C#" Value="public System.Data.Common.DbDataReader ExecuteReader ();" />
  369. <MemberType>Method</MemberType>
  370. <ReturnValue>
  371. <ReturnType>System.Data.Common.DbDataReader</ReturnType>
  372. </ReturnValue>
  373. <Parameters />
  374. <Docs>
  375. <remarks>To be added.</remarks>
  376. <since version=".NET 2.0" />
  377. <summary>
  378. <attribution license="cc4" from="Microsoft" modified="false" />
  379. <para>Executes the <see cref="P:System.Data.Common.DbCommand.CommandText" /> against the <see cref="P:System.Data.Common.DbCommand.Connection" />, and returns an <see cref="T:System.Data.Common.DbDataReader" />.</para>
  380. </summary>
  381. <returns>
  382. <attribution license="cc4" from="Microsoft" modified="false" />
  383. <para>A <see cref="T:System.Data.Common.DbDataReader" /> object.</para>
  384. </returns>
  385. </Docs>
  386. <AssemblyInfo>
  387. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  388. </AssemblyInfo>
  389. </Member>
  390. <Member MemberName="ExecuteReader">
  391. <MemberSignature Language="C#" Value="public System.Data.Common.DbDataReader ExecuteReader (System.Data.CommandBehavior behavior);" />
  392. <MemberType>Method</MemberType>
  393. <ReturnValue>
  394. <ReturnType>System.Data.Common.DbDataReader</ReturnType>
  395. </ReturnValue>
  396. <Parameters>
  397. <Parameter Name="behavior" Type="System.Data.CommandBehavior" />
  398. </Parameters>
  399. <Docs>
  400. <remarks>To be added.</remarks>
  401. <since version=".NET 2.0" />
  402. <summary>
  403. <attribution license="cc4" from="Microsoft" modified="false" />
  404. <para>Executes the <see cref="P:System.Data.Common.DbCommand.CommandText" /> against the <see cref="P:System.Data.Common.DbCommand.Connection" />, and returns an <see cref="T:System.Data.Common.DbDataReader" /> using one of the <see cref="T:System.Data.CommandBehavior" /> values. </para>
  405. </summary>
  406. <returns>
  407. <attribution license="cc4" from="Microsoft" modified="false" />
  408. <para>An <see cref="T:System.Data.Common.DbDataReader" /> object.</para>
  409. </returns>
  410. <param name="behavior">
  411. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.CommandBehavior" /> values.</param>
  412. </Docs>
  413. <AssemblyInfo>
  414. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  415. </AssemblyInfo>
  416. </Member>
  417. <Member MemberName="ExecuteScalar">
  418. <MemberSignature Language="C#" Value="public abstract object ExecuteScalar ();" />
  419. <MemberType>Method</MemberType>
  420. <ReturnValue>
  421. <ReturnType>System.Object</ReturnType>
  422. </ReturnValue>
  423. <Parameters />
  424. <Docs>
  425. <since version=".NET 2.0" />
  426. <remarks>
  427. <attribution license="cc4" from="Microsoft" modified="false" />
  428. <para>Use the <see cref="M:System.Data.Common.DbCommand.ExecuteScalar" /> method to retrieve a single value (for example, an aggregate value) from a database. This requires less code than using the <see cref="M:System.Data.Common.DbCommand.ExecuteReader" /> method and performing the operations necessary to generate the single value using the data returned by a <see cref="T:System.Data.Common.DbDataReader" />.</para>
  429. <para>If the first column of the first row in the result set is not found, a null reference (Nothing in Visual Basic) is returned. If the value in the database is null, the query returns DBNull.Value.</para>
  430. </remarks>
  431. <summary>
  432. <attribution license="cc4" from="Microsoft" modified="false" />
  433. <para>Executes the query and returns the first column of the first row in the result set returned by the query. All other columns and rows are ignored.</para>
  434. </summary>
  435. <returns>
  436. <attribution license="cc4" from="Microsoft" modified="false" />
  437. <para>The first column of the first row in the result set.</para>
  438. </returns>
  439. </Docs>
  440. <AssemblyInfo>
  441. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  442. </AssemblyInfo>
  443. </Member>
  444. <Member MemberName="Parameters">
  445. <MemberSignature Language="C#" Value="public System.Data.Common.DbParameterCollection Parameters { get; }" />
  446. <MemberType>Property</MemberType>
  447. <Attributes>
  448. <Attribute>
  449. <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
  450. </Attribute>
  451. <Attribute>
  452. <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
  453. </Attribute>
  454. </Attributes>
  455. <ReturnValue>
  456. <ReturnType>System.Data.Common.DbParameterCollection</ReturnType>
  457. </ReturnValue>
  458. <Docs>
  459. <value>To be added.</value>
  460. <remarks>To be added.</remarks>
  461. <since version=".NET 2.0" />
  462. <summary>
  463. <attribution license="cc4" from="Microsoft" modified="false" />
  464. <para>Gets the collection of <see cref="T:System.Data.Common.DbParameter" /> objects. For more information on parameters, see <format type="text/html"><a href="537d8a2c-d40b-4000-83eb-bc1fcc93f707">Configuring Parameters and Parameter Data Types (ADO.NET)</a></format>.</para>
  465. </summary>
  466. </Docs>
  467. <AssemblyInfo>
  468. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  469. </AssemblyInfo>
  470. </Member>
  471. <Member MemberName="Prepare">
  472. <MemberSignature Language="C#" Value="public abstract void Prepare ();" />
  473. <MemberType>Method</MemberType>
  474. <ReturnValue>
  475. <ReturnType>System.Void</ReturnType>
  476. </ReturnValue>
  477. <Parameters />
  478. <Docs>
  479. <since version=".NET 2.0" />
  480. <remarks>
  481. <attribution license="cc4" from="Microsoft" modified="false" />
  482. <para>If the <see cref="P:System.Data.Common.DbCommand.CommandType" /> property is set to TableDirect, Prepare does nothing. If <see cref="P:System.Data.Common.DbCommand.CommandType" /> is set to StoredProcedure, the call to Prepare should succeed, although it may result in a no-op.</para>
  483. </remarks>
  484. <summary>
  485. <attribution license="cc4" from="Microsoft" modified="false" />
  486. <para>Creates a prepared (or compiled) version of the command on the data source.</para>
  487. </summary>
  488. </Docs>
  489. <AssemblyInfo>
  490. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  491. </AssemblyInfo>
  492. </Member>
  493. <Member MemberName="System.Data.IDbCommand.Connection">
  494. <MemberSignature Language="C#" Value="System.Data.IDbConnection System.Data.IDbCommand.Connection { set; get; }" />
  495. <MemberType>Property</MemberType>
  496. <AssemblyInfo>
  497. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  498. </AssemblyInfo>
  499. <ReturnValue>
  500. <ReturnType>System.Data.IDbConnection</ReturnType>
  501. </ReturnValue>
  502. <Docs>
  503. <value>To be added.</value>
  504. <remarks>
  505. <attribution license="cc4" from="Microsoft" modified="false" />
  506. <para>For more information, see <see cref="M:System.Data.IDbCommand.Connection" />.</para>
  507. </remarks>
  508. <summary>
  509. <attribution license="cc4" from="Microsoft" modified="false" />
  510. <para>Gets or sets the <see cref="T:System.Data.IDbConnection" /> used by this instance of the <see cref="T:System.Data.IDbCommand" />.</para>
  511. </summary>
  512. </Docs>
  513. </Member>
  514. <Member MemberName="System.Data.IDbCommand.CreateParameter">
  515. <MemberSignature Language="C#" Value="System.Data.IDbDataParameter IDbCommand.CreateParameter ();" />
  516. <MemberType>Method</MemberType>
  517. <AssemblyInfo>
  518. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  519. </AssemblyInfo>
  520. <ReturnValue>
  521. <ReturnType>System.Data.IDbDataParameter</ReturnType>
  522. </ReturnValue>
  523. <Parameters />
  524. <Docs>
  525. <remarks>
  526. <attribution license="cc4" from="Microsoft" modified="false" />
  527. <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.Common.DbCommand" /> instance is cast to an <see cref="T:System.Data.IDbCommand" /> interface.</para>
  528. <para>For more information, see <see cref="M:System.Data.IDbCommand.CreateParameter" />.</para>
  529. </remarks>
  530. <summary>
  531. <attribution license="cc4" from="Microsoft" modified="false" />
  532. <para>Creates a new instance of an <see cref="T:System.Data.IDbDataParameter" /> object.</para>
  533. </summary>
  534. <returns>
  535. <attribution license="cc4" from="Microsoft" modified="false" />
  536. <para>An IDbDataParameter object.</para>
  537. </returns>
  538. </Docs>
  539. </Member>
  540. <Member MemberName="System.Data.IDbCommand.ExecuteReader">
  541. <MemberSignature Language="C#" Value="System.Data.IDataReader IDbCommand.ExecuteReader ();" />
  542. <MemberType>Method</MemberType>
  543. <AssemblyInfo>
  544. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  545. </AssemblyInfo>
  546. <ReturnValue>
  547. <ReturnType>System.Data.IDataReader</ReturnType>
  548. </ReturnValue>
  549. <Parameters />
  550. <Docs>
  551. <remarks>
  552. <attribution license="cc4" from="Microsoft" modified="false" />
  553. <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.Common.DbCommand" /> instance is cast to an <see cref="T:System.Data.IDbCommand" /> interface.</para>
  554. <para>For more information, see <see cref="M:System.Data.IDbCommand.ExecuteReader" />.</para>
  555. </remarks>
  556. <summary>
  557. <attribution license="cc4" from="Microsoft" modified="false" />
  558. <para>Executes the <see cref="P:System.Data.IDbCommand.CommandText" /> against the <see cref="P:System.Data.IDbCommand.Connection" /> and builds an <see cref="T:System.Data.IDataReader" />.</para>
  559. </summary>
  560. <returns>
  561. <attribution license="cc4" from="Microsoft" modified="false" />
  562. <para>An <see cref="T:System.Data.IDataReader" /> object.</para>
  563. </returns>
  564. </Docs>
  565. </Member>
  566. <Member MemberName="System.Data.IDbCommand.ExecuteReader">
  567. <MemberSignature Language="C#" Value="System.Data.IDataReader IDbCommand.ExecuteReader (System.Data.CommandBehavior behavior);" />
  568. <MemberType>Method</MemberType>
  569. <AssemblyInfo>
  570. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  571. </AssemblyInfo>
  572. <ReturnValue>
  573. <ReturnType>System.Data.IDataReader</ReturnType>
  574. </ReturnValue>
  575. <Parameters>
  576. <Parameter Name="behavior" Type="System.Data.CommandBehavior" />
  577. </Parameters>
  578. <Docs>
  579. <remarks>
  580. <attribution license="cc4" from="Microsoft" modified="false" />
  581. <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.Common.DbCommand" /> instance is cast to an <see cref="T:System.Data.IDbCommand" /> interface.</para>
  582. <para>For more information, see <see cref="M:System.Data.IDbCommand.ExecuteReader(System.Data.CommandBehavior)" />.</para>
  583. </remarks>
  584. <summary>
  585. <attribution license="cc4" from="Microsoft" modified="false" />
  586. <para>Executes the <see cref="P:System.Data.IDbCommand.CommandText" /> against the <see cref="P:System.Data.IDbCommand.Connection" />, and builds an <see cref="T:System.Data.IDataReader" /> using one of the <see cref="T:System.Data.CommandBehavior" /> values.</para>
  587. </summary>
  588. <returns>
  589. <attribution license="cc4" from="Microsoft" modified="false" />
  590. <para>An <see cref="T:System.Data.IDataReader" /> object.</para>
  591. </returns>
  592. <param name="behavior">
  593. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.CommandBehavior" /> values.</param>
  594. </Docs>
  595. </Member>
  596. <Member MemberName="System.Data.IDbCommand.Parameters">
  597. <MemberSignature Language="C#" Value="System.Data.IDataParameterCollection System.Data.IDbCommand.Parameters { get; }" />
  598. <MemberType>Property</MemberType>
  599. <AssemblyInfo>
  600. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  601. </AssemblyInfo>
  602. <ReturnValue>
  603. <ReturnType>System.Data.IDataParameterCollection</ReturnType>
  604. </ReturnValue>
  605. <Docs>
  606. <value>To be added.</value>
  607. <remarks>
  608. <attribution license="cc4" from="Microsoft" modified="false" />
  609. <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.Common.DbCommand" /> instance is cast to an <see cref="T:System.Data.IDbCommand" /> interface.</para>
  610. <para>For more information, see <see cref="M:System.Data.IDbCommand.Parameters" />.</para>
  611. </remarks>
  612. <summary>
  613. <attribution license="cc4" from="Microsoft" modified="false" />
  614. <para>Gets the <see cref="T:System.Data.IDataParameterCollection" />.</para>
  615. </summary>
  616. </Docs>
  617. </Member>
  618. <Member MemberName="System.Data.IDbCommand.Transaction">
  619. <MemberSignature Language="C#" Value="System.Data.IDbTransaction System.Data.IDbCommand.Transaction { set; get; }" />
  620. <MemberType>Property</MemberType>
  621. <AssemblyInfo>
  622. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  623. </AssemblyInfo>
  624. <ReturnValue>
  625. <ReturnType>System.Data.IDbTransaction</ReturnType>
  626. </ReturnValue>
  627. <Docs>
  628. <value>To be added.</value>
  629. <remarks>
  630. <attribution license="cc4" from="Microsoft" modified="false" />
  631. <para>For more information, see <see cref="M:System.Data.IDbCommand.Ttransaction" />.</para>
  632. </remarks>
  633. <summary>
  634. <attribution license="cc4" from="Microsoft" modified="false" />
  635. <para>Gets or sets the <see cref="P:System.Data.Common.DbCommand.DbTransaction" /> within which this <see cref="T:System.Data.Common.DbCommand" /> object executes.</para>
  636. </summary>
  637. </Docs>
  638. </Member>
  639. <Member MemberName="Transaction">
  640. <MemberSignature Language="C#" Value="public System.Data.Common.DbTransaction Transaction { set; get; }" />
  641. <MemberType>Property</MemberType>
  642. <Attributes>
  643. <Attribute>
  644. <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
  645. </Attribute>
  646. <Attribute>
  647. <AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName>
  648. </Attribute>
  649. <Attribute>
  650. <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
  651. </Attribute>
  652. </Attributes>
  653. <ReturnValue>
  654. <ReturnType>System.Data.Common.DbTransaction</ReturnType>
  655. </ReturnValue>
  656. <Docs>
  657. <value>To be added.</value>
  658. <remarks>To be added.</remarks>
  659. <since version=".NET 2.0" />
  660. <summary>
  661. <attribution license="cc4" from="Microsoft" modified="false" />
  662. <para>Gets or sets the <see cref="T:System.Data.Common.DbTransaction" /> within which this <see cref="T:System.Data.Common.DbCommand" /> object executes.</para>
  663. </summary>
  664. </Docs>
  665. <AssemblyInfo>
  666. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  667. </AssemblyInfo>
  668. </Member>
  669. <Member MemberName="UpdatedRowSource">
  670. <MemberSignature Language="C#" Value="public abstract System.Data.UpdateRowSource UpdatedRowSource { set; get; }" />
  671. <MemberType>Property</MemberType>
  672. <Attributes>
  673. <Attribute>
  674. <AttributeName>System.ComponentModel.DefaultValue(System.Data.UpdateRowSource.Both)</AttributeName>
  675. </Attribute>
  676. </Attributes>
  677. <ReturnValue>
  678. <ReturnType>System.Data.UpdateRowSource</ReturnType>
  679. </ReturnValue>
  680. <Docs>
  681. <value>To be added.</value>
  682. <since version=".NET 2.0" />
  683. <remarks>
  684. <attribution license="cc4" from="Microsoft" modified="false" />
  685. <para>Throws a <see cref="T:System.ArgumentException" /> if the value entered was not one of the <see cref="T:System.Data.UpdateRowSource" /> values.</para>
  686. </remarks>
  687. <summary>
  688. <attribution license="cc4" from="Microsoft" modified="false" />
  689. <para>Gets or sets how command results are applied to the <see cref="T:System.Data.DataRow" /> when used by the Update method of a <see cref="T:System.Data.Common.DbDataAdapter" />.</para>
  690. </summary>
  691. </Docs>
  692. <AssemblyInfo>
  693. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  694. </AssemblyInfo>
  695. </Member>
  696. </Members>
  697. </Type>