OdbcCommandBuilder.GetUpdateCommand Method

Definition

Namespace:

System.Data.Odbc

Assembly:

System.Data.Odbc.dll

Package:

System.Data.Odbc v9.0.0-rc.2.24473.5

Gets the automatically generated OdbcCommand object required to perform updates at the data source.

Overloads

GetUpdateCommand()	Gets the automatically generated OdbcCommand object required to perform updates at the data source.
GetUpdateCommand(Boolean)	Gets the automatically generated OdbcCommand object required to perform updates at the data source.

Remarks

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

After the SQL statement is first generated, you must explicitly call RefreshSchema if it changes the statement in any way. Otherwise, the GetUpdateCommand 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 GetUpdateCommand.

GetUpdateCommand()

Source:

OdbcCommandBuilder.cs

Gets the automatically generated OdbcCommand object required to perform updates at the data source.

public:
 System::Data::Odbc::OdbcCommand ^ GetUpdateCommand();

public System.Data.Odbc.OdbcCommand GetUpdateCommand ();

override this.GetUpdateCommand : unit -> System.Data.Odbc.OdbcCommand

Public Function GetUpdateCommand () As OdbcCommand

Returns

OdbcCommand

The automatically generated OdbcCommand object required to perform updates.

Remarks

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

After the SQL statement is first generated, you must explicitly call RefreshSchema if it changes the statement in any way. Otherwise, the GetUpdateCommand still 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 GetUpdateCommand.

See also

• Generating Commands with CommandBuilders

GetUpdateCommand(Boolean)

Source:

OdbcCommandBuilder.cs

Gets the automatically generated OdbcCommand object required to perform updates at the data source.

public:
 System::Data::Odbc::OdbcCommand ^ GetUpdateCommand(bool useColumnsForParameterNames);

public System.Data.Odbc.OdbcCommand GetUpdateCommand (bool useColumnsForParameterNames);

override this.GetUpdateCommand : bool -> System.Data.Odbc.OdbcCommand

Public Function GetUpdateCommand (useColumnsForParameterNames As Boolean) As OdbcCommand

Parameters

useColumnsForParameterNames

Boolean

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

Returns

OdbcCommand

The automatically generated OdbcCommand object required to perform updates.

Remarks

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

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

• The ParameterNameMaxLength 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 regular expression.

• A ParameterMarkerFormat is specified.

See also

• Generating Commands with CommandBuilders