This documentation is archived and is not being maintained.

DbCommandBuilder.GetDeleteCommand Method (Boolean)

Gets the automatically generated DbCommand object required to perform deletions at the data source, optionally using columns for parameter names.

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

public DbCommand GetDeleteCommand(
	bool useColumnsForParameterNames
)

Parameters

useColumnsForParameterNames
Type: System.Boolean
If true, generate parameter names matching column names, if possible. If false, generate @p1, @p2, and so on.

Return Value

Type: System.Data.Common.DbCommand
The automatically generated DbCommand object required to perform deletions.

An application can use the GetDeleteCommand method for informational or troubleshooting purposes because it returns the DbCommand 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 command text, and then explicitly set that on the DbDataAdapter.

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 still be using information from the previous statement, which might not be correct. The SQL statements are first generated either when the application calls 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 allows you to force the DbCommandBuilder to generate parameters based on the column names instead. This succeeds only if the following conditions are met:

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: