GetUpdateCommand Method (Boolean)
Collapse the table of content
Expand the table of content

OleDbCommandBuilder.GetUpdateCommand Method (Boolean)

 

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

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

public OleDbCommand GetUpdateCommand(
	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 updates.

An application can use the GetUpdateCommand method for informational or troubleshooting purposes because it returns the OleDbCommand object to be executed.

You can also use GetUpdateCommand as the basis of a modified command. For example, you might call GetUpdateCommand 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 GetUpdateCommand 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 M:System.Data.OleDb.OleDbDataAdapter.Update(System.Data.DataSet) or GetUpdateCommand.

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
Available since 2.0
Return to top
Show:
© 2016 Microsoft