dotConnect for SQL Server Documentation
Devart.Data.SqlServer Namespace / SqlCommandBuilder Class / GetDeleteCommand Method / GetDeleteCommand(Boolean) Method
Determines whether names of parameters in command text will be based on columns' names.

In This Topic
    GetDeleteCommand(Boolean) Method
    In This Topic
    Gets the automatically generated SQL statement required to perform deletions on the data source when an application calls System.Data.Common.DbDataAdapter.Update() on the SqlDataAdapter.
    Syntax
    'Declaration
     
    Public Overloads Shadows Function GetDeleteCommand( _
       ByVal useColumnsForParameterNames As Boolean _
    ) As SqlCommand
    public new SqlCommand GetDeleteCommand( 
       bool useColumnsForParameterNames
    )

    Parameters

    useColumnsForParameterNames
    Determines whether names of parameters in command text will be based on columns' names.

    Return Value

    The text of the SQL statement to be executed.
    Remarks
    You 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, you must explicitly call Devart.Common.DbCommandBuilderBase.RefreshSchema if it changes the statement in any way. Otherwise, the GetDeleteCommand 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 System.Data.Common.DbDataAdapter.Update(System.Data.DataSet) or GetDeleteCommand.

    useColumnsForParameterNames argument determines whether names of parameters in command text will be like ":p1", ":p2" (if false), or names of columns will be used (if true), like ":mycolumn1", ":myothercolumn".

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also