Execute an IDbCommand (that returns a 1x1 resultset) against the specified IDbConnection using the provided parameters.

Namespace: CodeSmith.Engine
Assembly: CodeSmith.Engine (in CodeSmith.Engine.dll) Version: 6.0.0.0 (7.0.0.15127)

Syntax

C#
public virtual Object ExecuteScalar(
	IDbConnection connection,
	CommandType commandType,
	string commandText,
	params IDataParameter[] commandParameters
)
Visual Basic
Public Overridable Function ExecuteScalar ( 
	connection As IDbConnection,
	commandType As CommandType,
	commandText As String,
	ParamArray commandParameters As IDataParameter()
) As Object

Parameters

connection
Type: System.Data..::..IDbConnection
A valid IDbConnection
commandType
Type: System.Data..::..CommandType
The CommandType (stored procedure, text, etc.)
commandText
Type: System..::..String
The stored procedure name or SQL command
commandParameters
Type: array<System.Data..::..IDataParameter>[]()[][]
An array of IDataParameters used to execute the command

Return Value

Type: Object
An object containing the value in the 1x1 resultset generated by the command

Exceptions

ExceptionCondition
System..::..InvalidOperationExceptionThrown if any of the IDataParameters.ParameterNames are null, or if the parameter count does not match the number of values supplied
System..::..ArgumentNullExceptionThrown if commandText is null
System..::..ArgumentExceptionThrown if the parameter count does not match the number of values supplied
System..::..ArgumentNullExceptionThrown if connection is null

See Also