Export (0) Print
Expand All

OleDbCommandBuilder.GetDeleteCommand Method (Boolean)

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

Namespace:  System.Data.OleDb
Assembly:  System.Data (in System.Data.dll)

public OleDbCommand GetDeleteCommand(
	bool useColumnsForParameterNames
)

Parameters

useColumnsForParameterNames
Type: System.Boolean

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

Return Value

Type: System.Data.OleDb.OleDbCommand
The automatically generated OleDbCommand object required to perform deletions.

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 Update 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:

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft