ExecuteScalar Method (sqlFormat, args)

DTF API

previous page next page
Copy image CopyHover image
Deployment Tools Foundation ExecuteScalar Method (sqlFormat, args)
Deployment Tools Foundation Namespaces ► Microsoft.Deployment.WindowsInstaller ► Database ► ExecuteScalar(String, array<Object>[]()[][])
Executes the specified SQL SELECT query and returns a single result.
Declaration Syntax
C# Visual Basic Visual C++ F# 
public Object ExecuteScalar(
	string sqlFormat,
	params Object[] args
)
Public Function ExecuteScalar ( 
	sqlFormat As String,
	ParamArray args As Object()
) As Object
public:
Object^ ExecuteScalar(
	String^ sqlFormat, 
	... array<Object^>^ args
)
member ExecuteScalar : 
        sqlFormat : string * 
        args : Object[] -> Object
Parameters
sqlFormat (String)
SQL query string, which may contain format items
args (array<Object>[]()[][])
Zero or more objects to format
Return Value
Object
First field of the first result
Remarks

The sqlFormat parameter is formatted using Format(String, array<Object>[]()[][]).

Win32 MSI APIs: MsiDatabaseOpenView, MsiViewExecute, MsiViewFetch

Exceptions
Exception Condition
BadQuerySyntaxException the SQL syntax is invalid
InstallerException the View could not be executed or the query returned 0 results
InvalidHandleException the Database handle is invalid

Assembly: Microsoft.Deployment.WindowsInstaller (Module: Microsoft.Deployment.WindowsInstaller.dll) Version: 3.0.0.0 (3.11.1.2318)

previous page start next page