OdbcCommandBuilder.GetDeleteCommand Method (Boolean)


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 OdbcCommand object required to perform deletions at the data source.

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

public OdbcCommand GetDeleteCommand(
	bool 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.Odbc.OdbcCommand

The automatically generated OdbcCommand object required to perform deletions.

You can use the GetDeleteCommand method for informational or troubleshooting purposes because it returns the OdbcCommand 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 OdbcDataAdapter.

After the SQL statement is first generated, you must explicitly call RefreshSchema if it changes the statement in any way. Otherwise, the GetDeleteCommand will 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 OdbcCommandBuilder to generate parameters based on the column names instead. This succeeds only if the following conditions are met:

.NET Framework
Available since 2.0
Return to top