ServerConnection.ExecuteNonQuery Method (StringCollection, ExecutionTypes)

Article
12/03/2008

Executes a batch of statements with the specified execution options that does not return a result set.

Namespace: Microsoft.SqlServer.Management.Common
Assembly: Microsoft.SqlServer.ConnectionInfo (in microsoft.sqlserver.connectioninfo.dll)

Syntax

'Declaration
Public Function ExecuteNonQuery ( _
    sqlCommands As StringCollection, _
    executionType As ExecutionTypes _
) As Integer()

public int[] ExecuteNonQuery (
    StringCollection sqlCommands,
    ExecutionTypes executionType
)

public:
array<int>^ ExecuteNonQuery (
    StringCollection^ sqlCommands, 
    ExecutionTypes executionType
)

public int[] ExecuteNonQuery (
    StringCollection sqlCommands, 
    ExecutionTypes executionType
)

public function ExecuteNonQuery (
    sqlCommands : StringCollection, 
    executionType : ExecutionTypes
) : int[]

Parameters

sqlCommands
A StringCollection system object value that specifies the batches of Transact-SQL statements to be executed.

executionType
An ExecutionTypes object value that specifies the execution options for the Transact-SQL statement.

Return Value

An Int32 array value that specifies the total number of rows affected by each element of the StringCollection object used as the sqlCommands parameter. The return value specifies the total number of rows affected by the Transact-SQL command for UPDATE, INSERT, and DELETE statements. For all other types of statements, the return value is -1.

Remarks

Executes batches of Transact-SQL statements that typically do not return result sets. These are typically data definition language (DDL) statements or stored procedures that affect the server settings.

The Text property of the CapturedSql object can be used as a parameter to allow execution of captured Transact-SQL statements.

The StringCollection object used as the sqlCommands parameter can contain several batches separated by the batch separator. By default, the batch separator is GO, but can be set with the BatchSeparator property. Batch execution is controlled with the executionType parameter.

Only SQLCMD commands are recognized by the ExecuteNonQuery method. If the sqlCommand parameter contains a statement that is not a SQLCMD command then the method fails and an ExecutionFailureException exception is raised unless the executionType parameter has been set to include the ExecutionTypes.ContinueOnError value.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Set the execution mode to CaptureSql for the connection.
srv.ConnectionContext.SqlExecutionModes = SqlExecutionModes.CaptureSql
'Make a modification to the server that is to be captured.
srv.UserOptions.AnsiNulls = True
srv.Alter()
'Iterate through the strings in the capture buffer and display the captured statements.
Dim s As String
For Each s In srv.ConnectionContext.CapturedSql.Text
    Console.WriteLine(s)
Next
'Execute the captured statements.
srv.ConnectionContext.ExecuteNonQuery(srv.ConnectionContext.CapturedSql.Text)
'Revert to immediate execution mode. 
srv.ConnectionContext.SqlExecutionModes = SqlExecutionModes.ExecuteSql

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Share via