OleDbCommandBuilder.GetDeleteCommand Method

Definition

Namespace:

System.Data.OleDb

Assembly:

System.Data.OleDb.dll

Package:

System.Data.OleDb v9.0.0-rc.2.24473.5

Gets the automatically generated OleDbCommand object required to perform deletions at the data source.

Overloads

GetDeleteCommand()	Gets the automatically generated OleDbCommand object required to perform deletions at the data source.
GetDeleteCommand(Boolean)	Gets the automatically generated OleDbCommand object required to perform deletions at the data source.

Remarks

An application can use the GetDeleteCommand method for informational or troubleshooting purposes because it returns the OleDbCommand object to be executed.

You can also use GetDeleteCommand as the basis of a modified command. For example, you might call GetDeleteCommand and modify the CommandTimeout value, and then explicitly set that on the OleDbDataAdapter.

After the SQL statement is first generated, the application must explicitly call RefreshSchema if it changes the statement in any way. Otherwise, the GetDeleteCommand will be still be using information from the previous statement, which might not be correct. The SQL statements are first generated when the application calls either UpdateCommand or GetDeleteCommand.

GetDeleteCommand()

Source:

OleDbCommandBuilder.cs

Gets the automatically generated OleDbCommand object required to perform deletions at the data source.

public:
 System::Data::OleDb::OleDbCommand ^ GetDeleteCommand();

public System.Data.OleDb.OleDbCommand GetDeleteCommand ();

override this.GetDeleteCommand : unit -> System.Data.OleDb.OleDbCommand

Public Function GetDeleteCommand () As OleDbCommand

Returns

OleDbCommand

The automatically generated OleDbCommand object required to perform deletions.

Remarks

An application can use the GetDeleteCommand method for informational or troubleshooting purposes because it returns the OleDbCommand object to be executed.

You can also use GetDeleteCommand as the basis of a modified command. For example, you might call GetDeleteCommand and modify the CommandTimeout value, and then explicitly set that on the OleDbDataAdapter.

After the SQL statement is first generated, the application must explicitly call RefreshSchema if it changes the statement in any way. Otherwise, the GetDeleteCommand will be still be using information from the previous statement, which might not be correct. The SQL statements are first generated when the application calls either UpdateCommand or GetDeleteCommand.

See also

• Generating Commands with CommandBuilders

GetDeleteCommand(Boolean)

Source:

OleDbCommandBuilder.cs

Gets the automatically generated OleDbCommand object required to perform deletions at the data source.

public:
 System::Data::OleDb::OleDbCommand ^ GetDeleteCommand(bool useColumnsForParameterNames);

public System.Data.OleDb.OleDbCommand GetDeleteCommand (bool useColumnsForParameterNames);

override this.GetDeleteCommand : bool -> System.Data.OleDb.OleDbCommand

Public Function GetDeleteCommand (useColumnsForParameterNames As Boolean) As OleDbCommand

Parameters

useColumnsForParameterNames

Boolean

If true, generate parameter names matching column names, if it is possible. If false, generate @p1, @p2, and so on.

Returns

OleDbCommand

The automatically generated OleDbCommand object required to perform deletions.

Remarks

An application can use the GetDeleteCommand method for informational or troubleshooting purposes because it returns the OleDbCommand object to be executed.

You can also use GetDeleteCommand as the basis of a modified command. For example, you might call GetDeleteCommand and modify the CommandTimeout value, and then explicitly set that on the OleDbDataAdapter.

After the SQL statement is first generated, the application must explicitly call RefreshSchema if it changes the statement in any way. Otherwise, the GetDeleteCommand will be still be using information from the previous statement, which might not be correct. The SQL statements are first generated when the application calls either UpdateCommand or GetDeleteCommand.

The default behavior, when generating parameter names, is to use @p1, @p2, and so on for the various parameters. Passing true for the useColumnsForParameterNames parameter lets you force the OleDbCommandBuilder to generate parameters based on the column names instead. This succeeds only if the following conditions are met:

• The ParameterNameMaxLength has been specified and its length is equal to or greater than the generated parameter name.

• The generated parameter name meets the criteria specified in the ParameterNamePattern regular expression.

• A ParameterMarkerFormat is specified.

See also

• Generating Commands with CommandBuilders