1128 lines
58 KiB
XML
1128 lines
58 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="OleDbCommand" FullName="System.Data.OleDb.OleDbCommand">
|
|
<TypeSignature Language="C#" Maintainer="auto" Value="public sealed class OleDbCommand : System.Data.Common.DbCommand, ICloneable" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Data</AssemblyName>
|
|
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
|
|
<AssemblyVersion>1.0.3300.0</AssemblyVersion>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
|
|
<Base>
|
|
<BaseTypeName>System.Data.Common.DbCommand</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>System.ICloneable</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultEvent("RecordsAffected")</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.ToolboxItem("System.Drawing.Design.ToolboxItem, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Designer("Microsoft.VSDesigner.Data.VS.OleDbCommandDesigner, Microsoft.VSDesigner, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.IDesigner")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>When an instance of <see cref="T:System.Data.OleDb.OleDbCommand" /> is created, the read/write properties are set to their initial values. For a list of these values, see the <see cref="T:System.Data.OleDb.OleDbCommand" /> constructor.</para>
|
|
<para>
|
|
<see cref="T:System.Data.OleDb.OleDbCommand" /> features the following methods executing commands at a data source: </para>
|
|
<list type="table">
|
|
<listheader>
|
|
<item>
|
|
<term>
|
|
<para>Item </para>
|
|
</term>
|
|
<description>
|
|
<para>Description </para>
|
|
</description>
|
|
</item>
|
|
</listheader>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="M:System.Data.OleDb.OleDbCommand.ExecuteReader" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>Executes commands that return rows. <see cref="M:System.Data.OleDb.OleDbCommand.ExecuteReader" /> may not have the effect that you want if used to execute commands such as SQL SET statements. </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="M:System.Data.OleDb.OleDbCommand.ExecuteNonQuery" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>Executes commands such as SQL INSERT, DELETE, UPDATE, and SET statements. </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="M:System.Data.OleDb.OleDbCommand.ExecuteScalar" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>Retrieves a single value, for example, an aggregate value from a database. </para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
<para>You can reset the <see cref="P:System.Data.OleDb.OleDbCommand.CommandText" /> property and reuse the <see cref="T:System.Data.OleDb.OleDbCommand" /> object. However, you must close the <see cref="T:System.Data.OleDb.OleDbDataReader" /> before you can execute a new or previous command.</para>
|
|
<para>If a fatal <see cref="T:System.Data.OleDb.OleDbException" /> (for example, a SQL Server severity level of 20 or greater) is generated by the method executing an <see cref="T:System.Data.OleDb.OleDbCommand" />, the <see cref="T:System.Data.OleDb.OleDbConnection" />, the connection may be closed. However, the user can reopen the connection and continue.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Represents an SQL statement or stored procedure to execute against a data source.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public OleDbCommand ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The base constructor initializes all fields to their default values. The following table shows initial property values for an instance of <see cref="T:System.Data.OleDb.OleDbCommand" />.</para>
|
|
<list type="table">
|
|
<listheader>
|
|
<item>
|
|
<term>
|
|
<para>Properties </para>
|
|
</term>
|
|
<description>
|
|
<para>Initial Value </para>
|
|
</description>
|
|
</item>
|
|
</listheader>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Data.OleDb.OleDbCommand.CommandText" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>empty string ("") </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="!:System.Data.OleDb.OleDbCommand.CommandTimeout" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>30 </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="!:System.Data.OleDb.OleDbCommand.CommandType" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>Text </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Data.OleDb.OleDbCommand.Connection" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>null </para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Data.OleDb.OleDbCommand" /> class.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public OleDbCommand (string cmdText);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="cmdText" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The following table shows initial property values for an instance of <see cref="T:System.Data.OleDb.OleDbCommand" />.</para>
|
|
<list type="table">
|
|
<listheader>
|
|
<item>
|
|
<term>
|
|
<para>Properties </para>
|
|
</term>
|
|
<description>
|
|
<para>Initial Value </para>
|
|
</description>
|
|
</item>
|
|
</listheader>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Data.OleDb.OleDbCommand.CommandText" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>
|
|
<paramref name="cmdText" /> </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="!:System.Data.OleDb.OleDbCommand.CommandTimeout" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>30 </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Data.IDbCommand.CommandType" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>Text </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Data.OleDb.OleDbCommand.Connection" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>null </para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Data.OleDb.OleDbCommand" /> class with the text of the query.</para>
|
|
</summary>
|
|
<param name="cmdText">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The text of the query. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public OleDbCommand (string cmdText, System.Data.OleDb.OleDbConnection connection);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="cmdText" Type="System.String" />
|
|
<Parameter Name="connection" Type="System.Data.OleDb.OleDbConnection" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The following table shows initial property values for an instance of <see cref="T:System.Data.OleDb.OleDbCommand" />.</para>
|
|
<list type="table">
|
|
<listheader>
|
|
<item>
|
|
<term>
|
|
<para>Properties </para>
|
|
</term>
|
|
<description>
|
|
<para>Initial Value </para>
|
|
</description>
|
|
</item>
|
|
</listheader>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Data.OleDb.OleDbCommand.CommandText" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>
|
|
<paramref name="cmdText" /> </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="!:System.Data.OleDb.OleDbCommand.CommandTimeout" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>30 </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Data.IDbCommand.CommandType" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>Text </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Data.OleDb.OleDbCommand.Connection" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>A new <see cref="T:System.Data.OleDb.OleDbConnection" /> that is the value for the <paramref name="connection" /> parameter. </para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
<para>You can change the value for any of these parameters by setting the related property.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Data.OleDb.OleDbCommand" /> class with the text of the query and an <see cref="T:System.Data.OleDb.OleDbConnection" />.</para>
|
|
</summary>
|
|
<param name="cmdText">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The text of the query. </param>
|
|
<param name="connection">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Data.OleDb.OleDbConnection" /> that represents the connection to a data source. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public OleDbCommand (string cmdText, System.Data.OleDb.OleDbConnection connection, System.Data.OleDb.OleDbTransaction transaction);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="cmdText" Type="System.String" />
|
|
<Parameter Name="connection" Type="System.Data.OleDb.OleDbConnection" />
|
|
<Parameter Name="transaction" Type="System.Data.OleDb.OleDbTransaction" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The following table shows initial property values for an instance of <see cref="T:System.Data.OleDb.OleDbCommand" />.</para>
|
|
<list type="table">
|
|
<listheader>
|
|
<item>
|
|
<term>
|
|
<para>Properties </para>
|
|
</term>
|
|
<description>
|
|
<para>Initial Value </para>
|
|
</description>
|
|
</item>
|
|
</listheader>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Data.OleDb.OleDbCommand.CommandText" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>
|
|
<paramref name="cmdText" /> </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="!:System.Data.OleDb.OleDbCommand.CommandTimeout" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>30 </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Data.IDbCommand.CommandType" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>Text </para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Data.OleDb.OleDbCommand.Connection" /> </para>
|
|
</term>
|
|
<description>
|
|
<para>A new <see cref="T:System.Data.OleDb.OleDbConnection" /> that is the value for the <paramref name="connection" /> parameter. </para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
<para>You can change the value for any of these parameters by setting the related property.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Data.OleDb.OleDbCommand" /> class with the text of the query, an <see cref="T:System.Data.OleDb.OleDbConnection" />, and the <see cref="P:System.Data.OleDb.OleDbCommand.Transaction" />.</para>
|
|
</summary>
|
|
<param name="cmdText">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The text of the query. </param>
|
|
<param name="connection">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Data.OleDb.OleDbConnection" /> that represents the connection to a data source. </param>
|
|
<param name="transaction">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The transaction in which the <see cref="T:System.Data.OleDb.OleDbCommand" /> executes. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Cancel">
|
|
<MemberSignature Language="C#" Value="public override void Cancel ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If there is nothing to cancel, nothing occurs. However, if there is a command in process, and the attempt to cancel fails, no exception is generated.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Tries to cancel the execution of an <see cref="T:System.Data.OleDb.OleDbCommand" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Clone">
|
|
<MemberSignature Language="C#" Value="public System.Data.OleDb.OleDbCommand Clone ();" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.OleDb.OleDbCommand</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Creates a new <see cref="T:System.Data.OleDb.OleDbCommand" /> object that is a copy of the current instance.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A new <see cref="T:System.Data.OleDb.OleDbCommand" /> object that is a copy of this instance.</para>
|
|
</returns>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CommandText">
|
|
<MemberSignature Language="C#" Value="public override string CommandText { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<value>To be added: an object of type 'string'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>When the <see cref="P:System.Data.OleDb.OleDbCommand.CommandType" /> property is set to StoredProcedure, the <see cref="P:System.Data.OleDb.OleDbCommand.CommandType" /> property should be set to the name of the stored procedure. The user may be required to use escape character syntax if the stored procedure name contains any special characters. The command executes this stored procedure when you call one of the Execute methods.</para>
|
|
<para>When <see cref="P:System.Data.OleDb.OleDbCommand.CommandType" /> is set to TableDirect, the <see cref="P:System.Data.OleDb.OleDbCommand.CommandType" /> property should be set to the name of the table or tables to be accessed. The user may be required to use escape character syntax if any of the named tables contain any special characters. All rows and columns of the named table or tables will be returned when you call one of the Execute methods.</para>
|
|
<para>You cannot set the <see cref="P:System.Data.OleDb.OleDbCommand.Connection" />, <see cref="P:System.Data.OleDb.OleDbCommand.CommandType" />, and <see cref="P:System.Data.OleDb.OleDbCommand.CommandText" /> properties if the current connection is performing an execute or fetch operation.</para>
|
|
<para>The OLE DB.NET Provider does not support named parameters for passing parameters to an SQL Statement or a stored procedure called by an <see cref="T:System.Data.OleDb.OleDbCommand" /> when <see cref="P:System.Data.OleDb.OleDbCommand.CommandType" /> is set to Text. In this case, the question mark (?) placeholder must be used. For example: </para>
|
|
<para>SELECT * FROM Customers WHERE CustomerID = ? </para>
|
|
<para>Therefore, the order in which <see cref="T:System.Data.OleDb.OleDbParameter" /> objects are added to the <see cref="T:System.Data.OleDb.OleDbParameterCollection" /> must directly correspond to the position of the question mark placeholder for the parameter.</para>
|
|
<para>For more information, see <format type="text/html"><a href="537d8a2c-d40b-4000-83eb-bc1fcc93f707">Using Stored Procedures with a Command</a></format>.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the SQL statement or stored procedure to execute at the data source.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.All)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Editor("Microsoft.VSDesigner.Data.ADO.Design.OleDbCommandTextEditor, 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>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="CommandTimeout">
|
|
<MemberSignature Language="C#" Value="public override int CommandTimeout { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<value>To be added: an object of type 'int'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A value of 0 indicates no limit, and should be avoided in a <see cref="P:System.Data.OleDb.OleDbCommand.CommandTimeout" /> because an attempt to execute a command will wait indefinitely.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the wait time before terminating an attempt to execute a command and generating an error.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="CommandType">
|
|
<MemberSignature Language="C#" Value="public override System.Data.CommandType CommandType { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.CommandType</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<value>To be added: an object of type 'Data.CommandType'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>When you set the <see cref="P:System.Data.OleDb.OleDbCommand.CommandType" /> property to StoredProcedure, you should set the <see cref="P:System.Data.OleDb.OleDbCommand.CommandText" /> property to the name of the stored procedure. The command executes this stored procedure when you call one of the Execute methods.</para>
|
|
<para>The <see cref="P:System.Data.OleDb.OleDbCommand.Connection" />, <see cref="P:System.Data.OleDb.OleDbCommand.CommandType" /> and <see cref="P:System.Data.OleDb.OleDbCommand.CommandText" /> properties cannot be set if the current connection is performing an execute or fetch operation.</para>
|
|
<para>The OLE DB .NET Provider does not support named parameters for passing parameters to an SQL statement or a stored procedure called by an <see cref="T:System.Data.OleDb.OleDbCommand" /> when <see cref="P:System.Data.OleDb.OleDbCommand.CommandType" /> is set to Text. In this case, the question mark (?) placeholder must be used. For example:</para>
|
|
<para>SELECT * FROM Customers WHERE CustomerID = ?</para>
|
|
<para>Therefore, the order in which <see cref="T:System.Data.OleDb.OleDbParameter" /> objects are added to the <see cref="T:System.Data.OleDb.OleDbParameterCollection" /> must directly correspond to the position of the question mark placeholder for the parameter. For more information, see <format type="text/html"><a href="537d8a2c-d40b-4000-83eb-bc1fcc93f707">Using Stored Procedures with a Command</a></format>.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value that indicates how the <see cref="P:System.Data.OleDb.OleDbCommand.CommandText" /> property is interpreted.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.RefreshProperties(System.ComponentModel.RefreshProperties.All)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue("Text")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="Connection">
|
|
<MemberSignature Language="C#" Value="public System.Data.OleDb.OleDbConnection Connection { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.OleDb.OleDbConnection</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<value>To be added: an object of type 'OleDbConnection'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>You cannot set the <see cref="P:System.Data.OleDb.OleDbCommand.Connection" />, <see cref="P:System.Data.OleDb.OleDbCommand.CommandType" /> and <see cref="P:System.Data.OleDb.OleDbCommand.CommandText" /> properties if the current connection is performing an execute or fetch operation.</para>
|
|
<para>If you set <see cref="P:System.Data.OleDb.OleDbCommand.Connection" /> while a transaction is in progress and the <see cref="P:System.Data.OleDb.OleDbCommand.Transaction" /> property is not null, an <see cref="T:System.InvalidOperationException" /> is generated. If the <see cref="P:System.Data.OleDb.OleDbCommand.Transaction" /> property is not null and the transaction has already been committed or rolled back, <see cref="P:System.Data.OleDb.OleDbCommand.Transaction" /> is set to null.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the <see cref="T:System.Data.OleDb.OleDbConnection" /> used by this instance of the <see cref="T:System.Data.OleDb.OleDbCommand" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Editor("Microsoft.VSDesigner.Data.Design.DbConnectionEditor, 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>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="CreateDbParameter">
|
|
<MemberSignature Language="C#" Value="protected override System.Data.Common.DbParameter CreateDbParameter ();" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.Common.DbParameter</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CreateParameter">
|
|
<MemberSignature Language="C#" Value="public System.Data.OleDb.OleDbParameter CreateParameter ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.OleDb.OleDbParameter</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Data.OleDb.OleDbCommand.CreateParameter" /> method is a strongly typed version of <see cref="M:System.Data.IDbCommand.CreateParameter" />.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Creates a new instance of an <see cref="T:System.Data.OleDb.OleDbParameter" /> object.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An <see cref="T:System.Data.OleDb.OleDbParameter" /> object.</para>
|
|
</returns>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="DbConnection">
|
|
<MemberSignature Language="C#" Value="protected override System.Data.Common.DbConnection DbConnection { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.Common.DbConnection</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DbParameterCollection">
|
|
<MemberSignature Language="C#" Value="protected override System.Data.Common.DbParameterCollection DbParameterCollection { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.Common.DbParameterCollection</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DbTransaction">
|
|
<MemberSignature Language="C#" Value="protected override System.Data.Common.DbTransaction DbTransaction { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.Common.DbTransaction</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DesignTimeVisible">
|
|
<MemberSignature Language="C#" Value="public override bool DesignTimeVisible { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<value>To be added: an object of type 'bool'</value>
|
|
<remarks>To be added</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value that indicates whether the command object should be visible in a customized Windows Forms Designer control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(true)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DesignOnly(true)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="Dispose">
|
|
<MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="disposing" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="disposing">To be added: an object of type 'bool'</param>
|
|
<summary>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ExecuteDbDataReader">
|
|
<MemberSignature Language="C#" Value="protected override System.Data.Common.DbDataReader ExecuteDbDataReader (System.Data.CommandBehavior behavior);" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.Common.DbDataReader</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="behavior" Type="System.Data.CommandBehavior" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="behavior">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ExecuteNonQuery">
|
|
<MemberSignature Language="C#" Value="public override int ExecuteNonQuery ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>You can use the <see cref="M:System.Data.OleDb.OleDbCommand.ExecuteNonQuery" /> to perform catalog operations, for example, to query the structure of a database or to create database objects such as tables, or to change the data in a database without using a <see cref="T:System.Data.DataSet" /> by executing UPDATE, INSERT, or DELETE statements.</para>
|
|
<para>Although the <see cref="M:System.Data.OleDb.OleDbCommand.ExecuteNonQuery" /> returns no rows, any output parameters or return values mapped to parameters are populated with data.</para>
|
|
<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. If a rollback occurs, the return value is also -1.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Executes an SQL statement against the <see cref="P:System.Data.OleDb.OleDbCommand.Connection" /> and returns the number of rows affected.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The number of rows affected.</para>
|
|
</returns>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ExecuteReader">
|
|
<MemberSignature Language="C#" Value="public System.Data.OleDb.OleDbDataReader ExecuteReader ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.OleDb.OleDbDataReader</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>When the <see cref="P:System.Data.OleDb.OleDbCommand.CommandType" /> property is set to StoredProcedure, the <see cref="P:System.Data.OleDb.OleDbCommand.CommandText" /> property should be set to the name of the stored procedure. The command executes this stored procedure when you call <see cref="M:System.Data.OleDb.OleDbCommand.ExecuteReader" />.</para>
|
|
<para>Before you close the <see cref="T:System.Data.OleDb.OleDbConnection" />, first close the <see cref="T:System.Data.OleDb.OleDbDataReader" /> object. You must also close the <see cref="T:System.Data.OleDb.OleDbDataReader" /> object if you plan to reuse an <see cref="T:System.Data.OleDb.OleDbCommand" /> object.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Sends the <see cref="P:System.Data.OleDb.OleDbCommand.CommandText" /> to the <see cref="P:System.Data.OleDb.OleDbCommand.Connection" /> and builds an <see cref="T:System.Data.OleDb.OleDbDataReader" />.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An <see cref="T:System.Data.OleDb.OleDbDataReader" /> object.</para>
|
|
</returns>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ExecuteReader">
|
|
<MemberSignature Language="C#" Value="public System.Data.OleDb.OleDbDataReader ExecuteReader (System.Data.CommandBehavior behavior);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.OleDb.OleDbDataReader</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="behavior" Type="System.Data.CommandBehavior" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>When you specify <see cref="F:System.Data.CommandBehavior.SingleRow" /> with the <see cref="M:System.Data.OleDb.OleDbCommand.ExecuteReader" /> method of the <see cref="T:System.Data.OleDb.OleDbCommand" /> object, the .NET Framework Data Provider for OLE DB performs binding using the OLE DB IRow interface if it is available. Otherwise, it uses the IRowset interface. If your SQL statement is expected to return only a single row, specifying <see cref="F:System.Data.CommandBehavior.SingleRow" /> can also improve application performance.</para>
|
|
<para>When the <see cref="P:System.Data.OleDb.OleDbCommand.CommandType" /> property is set to StoredProcedure, the <see cref="P:System.Data.OleDb.OleDbCommand.CommandText" /> property should be set to the name of the stored procedure. The command executes this stored procedure when you call <see cref="M:System.Data.OleDb.OleDbCommand.ExecuteReader" />.</para>
|
|
<para>The <see cref="T:System.Data.OleDb.OleDbDataReader" /> supports a special mode that enables large binary values to be read efficiently. For more information, see the SequentialAccess setting for <see cref="T:System.Data.CommandBehavior" />.</para>
|
|
<para>Before you close the <see cref="T:System.Data.OleDb.OleDbConnection" />, first close the <see cref="T:System.Data.OleDb.OleDbDataReader" /> object. You must also close the <see cref="T:System.Data.OleDb.OleDbDataReader" /> object if you plan to reuse an <see cref="T:System.Data.OleDb.OleDbCommand" /> object. If the <see cref="T:System.Data.OleDb.OleDbDataReader" /> is created with <see cref="T:System.Data.CommandBehavior" /> set to CloseConnection, closing the <see cref="T:System.Data.OleDb.OleDbDataReader" /> closes the connection automatically.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Sends the <see cref="P:System.Data.OleDb.OleDbCommand.CommandText" /> to the <see cref="P:System.Data.OleDb.OleDbCommand.Connection" />, and builds an <see cref="T:System.Data.OleDb.OleDbDataReader" /> using one of the <see cref="T:System.Data.CommandBehavior" /> values.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An <see cref="T:System.Data.OleDb.OleDbDataReader" /> object.</para>
|
|
</returns>
|
|
<param name="behavior">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.CommandBehavior" /> values. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ExecuteScalar">
|
|
<MemberSignature Language="C#" Value="public override object ExecuteScalar ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Object</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="M:System.Data.OleDb.OleDbCommand.ExecuteScalar" /> method to retrieve a single value, for example, an aggregate value, from a data source. This requires less code than using the <see cref="M:System.Data.OleDb.OleDbCommand.ExecuteReader" /> method, and then performing the operations that are required to generate the single value using the data returned by an <see cref="T:System.Data.OleDb.OleDbDataReader" />.</para>
|
|
<para>A typical <see cref="M:System.Data.OleDb.OleDbCommand.ExecuteScalar" /> query can be formatted as in the following C# example: </para>
|
|
<code>CommandText = "SELECT COUNT(*) FROM region";
|
|
Int32 count = (int32) ExecuteScalar();</code>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Executes the query, and returns the first column of the first row in the result set returned by the query. Additional columns or rows are ignored.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The first column of the first row in the result set, or a null reference if the result set is empty.</para>
|
|
</returns>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Parameters">
|
|
<MemberSignature Language="C#" Value="public System.Data.OleDb.OleDbParameterCollection Parameters { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.OleDb.OleDbParameterCollection</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added: an object of type 'OleDbParameterCollection'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The OLE DB .NET Provider does not support named parameters for passing parameters to an SQL statement or a stored procedure called by an <see cref="T:System.Data.OleDb.OleDbCommand" /> when <see cref="P:System.Data.OleDb.OleDbCommand.CommandType" /> is set to Text. In this case, the question mark (?) placeholder must be used. For example: </para>
|
|
<para>SELECT * FROM Customers WHERE CustomerID = ?</para>
|
|
<para>Therefore, the order in which <see cref="T:System.Data.OleDb.OleDbParameter" /> objects are added to the <see cref="T:System.Data.OleDb.OleDbParameterCollection" /> must directly correspond to the position of the question mark placeholder for the parameter in the command text.</para>
|
|
<block subset="none" type="note">
|
|
<para>If the parameters in the collection do not match the requirements of the query to be executed, an error may result.</para>
|
|
</block>
|
|
<para>For more information, see <format type="text/html"><a href="537d8a2c-d40b-4000-83eb-bc1fcc93f707">Using Stored Procedures with a Command</a></format>.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the <see cref="T:System.Data.OleDb.OleDbParameterCollection" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Content)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="Prepare">
|
|
<MemberSignature Language="C#" Value="public override void Prepare ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If the <see cref="P:System.Data.OleDb.OleDbCommand.CommandType" /> property is set to TableDirect, <see cref="M:System.Data.OleDb.OleDbCommand.Prepare" /> does nothing. If <see cref="P:System.Data.OleDb.OleDbCommand.CommandType" /> is set to StoredProcedure, the call to <see cref="M:System.Data.OleDb.OleDbCommand.Prepare" /> should succeed, although it may cause a no-op.</para>
|
|
<para>Before you call <see cref="M:System.Data.OleDb.OleDbCommand.Prepare" />, specify the data type of each parameter in the statement to be prepared. For each parameter that has a variable length data type, you must set the Size property to the maximum size needed. <see cref="M:System.Data.OleDb.OleDbCommand.Prepare" /> returns an error if these conditions are not met.</para>
|
|
<para>If you call an Execute method after you call <see cref="M:System.Data.OleDb.OleDbCommand.Prepare" />, any parameter value that is larger than the value specified by the Size property is automatically truncated to the original specified size of the parameter, and no truncation errors are returned.</para>
|
|
<para>Output parameters (whether prepared or not) must have a user-specified data type. If you specify a variable length data type, you must also specify the maximum Size.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Creates a prepared (or compiled) version of the command on the data source.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ResetCommandTimeout">
|
|
<MemberSignature Language="C#" Value="public void ResetCommandTimeout ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The default value of the <see cref="P:System.Data.OleDb.OleDbCommand.CommandTimeout" /> is 30 seconds.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Resets the <see cref="P:System.Data.OleDb.OleDbCommand.CommandTimeout" /> property to the default value.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="System.Data.IDbCommand.Connection">
|
|
<MemberSignature Language="C#" Value="System.Data.IDbConnection System.Data.IDbCommand.Connection { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.IDbConnection</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="System.Data.IDbCommand.CreateParameter">
|
|
<MemberSignature Language="C#" Value="System.Data.IDbDataParameter IDbCommand.CreateParameter ();" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.IDbDataParameter</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="System.Data.IDbCommand.ExecuteReader">
|
|
<MemberSignature Language="C#" Value="System.Data.IDataReader IDbCommand.ExecuteReader ();" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.IDataReader</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.OleDb.OleDbCommand" /> instance is cast to an <see cref="T:System.Data.IDbCommand" /> interface.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>For a description of this member, see <see cref="M:System.Data.IDbCommand.ExecuteReader" />.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An <see cref="T:System.Data.IDataReader" /> object.</para>
|
|
</returns>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="System.Data.IDbCommand.ExecuteReader">
|
|
<MemberSignature Language="C#" Value="System.Data.IDataReader IDbCommand.ExecuteReader (System.Data.CommandBehavior behavior);" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.IDataReader</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="behavior" Type="System.Data.CommandBehavior" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.OleDb.OleDbCommand" /> instance is cast to an <see cref="T:System.Data.IDbCommand" /> interface.</para>
|
|
<para>For a description of this member, see <see cref="M:System.Data.IDbCommand.ExecuteReader" />.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<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>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An <see cref="T:System.Data.IDataReader" /> built using one of the <see cref="T:System.Data.CommandBehavior" /> values.</para>
|
|
</returns>
|
|
<param name="behavior">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.CommandBehavior" /> values.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="System.Data.IDbCommand.Parameters">
|
|
<MemberSignature Language="C#" Value="System.Data.IDataParameterCollection System.Data.IDbCommand.Parameters { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.IDataParameterCollection</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="System.Data.IDbCommand.Transaction">
|
|
<MemberSignature Language="C#" Value="System.Data.IDbTransaction System.Data.IDbCommand.Transaction { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.IDbTransaction</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="System.ICloneable.Clone">
|
|
<MemberSignature Language="C#" Value="object ICloneable.Clone ();" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Object</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.OleDb.OleDbCommand" /> instance is cast to an <see cref="T:System.ICloneable" /> interface.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>For a description of this member, see <see cref="M:System.ICloneable.Clone" />.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A new <see cref="T:System.Object" /> that is a copy of this instance.</para>
|
|
</returns>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Transaction">
|
|
<MemberSignature Language="C#" Value="public System.Data.OleDb.OleDbTransaction Transaction { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.OleDb.OleDbTransaction</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<value>To be added: an object of type 'OleDbTransaction'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>You cannot set the <see cref="P:System.Data.OleDb.OleDbCommand.Transaction" /> property if it is already set to a specific value, and the command is in the process of executing. If you set the transaction property to an <see cref="T:System.Data.OleDb.OleDbTransaction" /> object that is not connected to the same <see cref="T:System.Data.OleDb.OleDbConnection" /> as the <see cref="T:System.Data.OleDb.OleDbCommand" /> object, an exception is thrown the next time that you try to execute a statement.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the <see cref="T:System.Data.OleDb.OleDbTransaction" /> within which the <see cref="T:System.Data.OleDb.OleDbCommand" /> executes.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="UpdatedRowSource">
|
|
<MemberSignature Language="C#" Value="public override System.Data.UpdateRowSource UpdatedRowSource { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Data.UpdateRowSource</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<value>To be added: an object of type 'Data.UpdateRowSource'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The default <see cref="P:System.Data.OleDb.OleDbCommand.UpdatedRowSource" /> value is Both unless the command is automatically generated (as with the <see cref="T:System.Data.OleDb.OleDbCommandBuilder" />), in which case the default is None.</para>
|
|
<para>For more information about how to use the <see cref="P:System.Data.OleDb.OleDbCommand.UpdatedRowSource" /> property, see <format type="text/html"><a href="f21e6aba-b76d-46ad-a83e-2ad8e0af1e12">Using Parameters with a DataAdapter</a></format>.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets how command results are applied to the <see cref="T:System.Data.DataRow" /> when used by the Update method of the <see cref="T:System.Data.OleDb.OleDbDataAdapter" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DefaultValue(System.Data.UpdateRowSource.Both)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
</Members>
|
|
</Type> |