Export (0) Print
Expand All

SqlCommandBuilder.GetInsertCommand Method (Boolean)

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

Namespace: System.Data.SqlClient
Assembly: System.Data (in system.data.dll)

public SqlCommand GetInsertCommand (
	bool useColumnsForParameterNames
)
public SqlCommand GetInsertCommand (
	boolean useColumnsForParameterNames
)
public function GetInsertCommand (
	useColumnsForParameterNames : boolean
) : SqlCommand
Not applicable.

Parameters

useColumnsForParameterNames

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

Return Value

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

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

You can also use GetInsertCommand as the basis of a modified command. For example, you might call GetInsertCommand and modify the CommandTimeout value, and then explicitly set that on the SqlDataAdapter.

After the Transact-SQL statement is first generated, the application must explicitly call RefreshSchema if it changes the statement in any way. Otherwise, the GetInsertCommand will still be using information from the previous statement, which might not be correct. The Transact-SQL statements are first generated when the application calls either Update or GetInsertCommand.

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 Automatically Generating Commands.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft