SqlCommandBuilder.GetDeleteCommand Method

Definition

Namespace:

System.Data.SqlClient

Assembly:

System.Data.SqlClient.dll

Package:

System.Data.SqlClient v4.9.0

Gets the automatically generated SqlCommand object required to perform deletions on the database.

Overloads

GetDeleteCommand()	Gets the automatically generated SqlCommand object required to perform deletions on the database.
GetDeleteCommand(Boolean)	Gets the automatically generated SqlCommand object that is required to perform deletions on the database.

Remarks

An application can use the GetDeleteCommand method for informational or troubleshooting purposes because it returns the SqlCommand 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 SqlDataAdapter.

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 when the application calls either Update or GetDeleteCommand.

For more information, see Generating Commands with CommandBuilders.

GetDeleteCommand()

Source:

System.Data.SqlClient.notsupported.cs

Gets the automatically generated SqlCommand object required to perform deletions on the database.

public:
 System::Data::SqlClient::SqlCommand ^ GetDeleteCommand();

public System.Data.SqlClient.SqlCommand GetDeleteCommand ();

override this.GetDeleteCommand : unit -> System.Data.SqlClient.SqlCommand

Public Function GetDeleteCommand () As SqlCommand

Returns

SqlCommand

The automatically generated SqlCommand object required to perform deletions.

Remarks

An application can use the GetDeleteCommand method for informational or troubleshooting purposes because it returns the SqlCommand 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 SqlDataAdapter.

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 when the application calls either Update or GetDeleteCommand.

For more information, see Generating Commands with CommandBuilders.

See also

• Connecting and Retrieving Data in ADO.NET
• Using the .NET Framework Data Provider for SQL Server
• ADO.NET Overview

GetDeleteCommand(Boolean)

Source:

System.Data.SqlClient.notsupported.cs

Gets the automatically generated SqlCommand object that is required to perform deletions on the database.

public:
 System::Data::SqlClient::SqlCommand ^ GetDeleteCommand(bool useColumnsForParameterNames);

public System.Data.SqlClient.SqlCommand GetDeleteCommand (bool useColumnsForParameterNames);

override this.GetDeleteCommand : bool -> System.Data.SqlClient.SqlCommand

Public Function GetDeleteCommand (useColumnsForParameterNames As Boolean) As SqlCommand

Parameters

useColumnsForParameterNames

Boolean

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

Returns

SqlCommand

The automatically generated SqlCommand object that is required to perform deletions.

Remarks

An application can use the GetDeleteCommand method for informational or troubleshooting purposes because it returns the SqlCommand 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 SqlDataAdapter.

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

• The ParameterNameMaxLength returned from the GetSchema method call and found in the DataSourceInformation collection 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 returned from the GetSchema method call and found in the DataSourceInformation collection regular expression.

• A ParameterMarkerFormat returned from the GetSchema method call and found in the DataSourceInformation collection is specified.

For more information, see Generating Commands with CommandBuilders.

See also

• Connecting and Retrieving Data in ADO.NET
• Using the .NET Framework Data Provider for SQL Server
• ADO.NET Overview