ServerConnection.ExecuteScalar Method (StringCollection)

Executes a batch of Transact-SQL statements and returns the first column of the first row as an object value.

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

Syntax

'Declaration
Public Function ExecuteScalar ( _
    sqlCommands As StringCollection _
) As Object()
'Usage
Dim instance As ServerConnection 
Dim sqlCommands As StringCollection 
Dim returnValue As Object()

returnValue = instance.ExecuteScalar(sqlCommands)

public Object[] ExecuteScalar(
    StringCollection sqlCommands
)

public:
array<Object^>^ ExecuteScalar(
    StringCollection^ sqlCommands
)

member ExecuteScalar : 
        sqlCommands:StringCollection -> Object[] 

public function ExecuteScalar(
    sqlCommands : StringCollection
) : Object[]

Parameters

• sqlCommands
  Type: System.Collections.Specialized.StringCollection
  A StringCollection system object value that specifies the batches of Transact-SQL statements to be executed.

Return Value

Type: array<System.Object[]
An object array value that specifies the first column of the first row for each result set.

Examples

C#

ServerConnection conn = new ServerConnection();
conn.DatabaseName = "AdventureWorks2012";
StringCollection sqlQuery = new StringCollection();
sqlQuery.Add("SELECT Name FROM Production.Location");
sqlQuery.Add("SELECT CostRate FROM Production.Location");
Object[] costData = conn.ExecuteScalar(sqlQuery);
for (int i = 0; i < costData.Length; i++)
{
   Console.WriteLine(costData[i].ToString());
}

PowerShell

$conn = new-object Microsoft.SqlServer.Management.Common.ServerConnection
$conn.DatabaseName = "AdventureWorks2012"
$sqlQuery = new-object System.Collections.Specialized.StringCollection
$sqlQuery.Add("SELECT Name FROM Production.Location")
$sqlQuery.Add("SELECT CostRate FROM Production.Location")
$costData = $conn.ExecuteScalar($sqlQuery)
$i = 0
while ($i -le $costData.Length)
{
   Write-Host $costData[$i]
   $i++
}

See Also

Reference

ServerConnection Class

ExecuteScalar Overload

Microsoft.SqlServer.Management.Common Namespace

Other Resources

Calling Methods