DbCommandBuilder.GetDeleteCommand Method

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

NameDescription
System_CAPS_pubmethodGetDeleteCommand()

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

System_CAPS_pubmethodGetDeleteCommand(Boolean)

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

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 associated 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. If the overloaded version of GetDeleteCommand allows you to specify this behavior by supplying a Boolean value, you can cause the DbCommandBuilder to generate parameters based on the column names instead by passing True.

Return to top
Show: