MsiDatabaseOpenViewA function (msiquery.h)

The MsiDatabaseOpenView function prepares a database query and creates a view object. This function returns a handle that should be closed using MsiCloseHandle.

Syntax

UINT MsiDatabaseOpenViewA(
  [in]  MSIHANDLE hDatabase,
  [in]  LPCSTR    szQuery,
  [out] MSIHANDLE *phView
);

Parameters

[in] hDatabase

Handle to the database to which you want to open a view object. You can get the handle as described in Obtaining a Database Handle.

[in] szQuery

Specifies a SQL query string for querying the database. For correct syntax, see SQL Syntax.

[out] phView

Pointer to a handle for the returned view.

Return value

The MsiDatabaseOpenView function returns one of the following values:

ERROR_SUCCESS if successful, and the view handle which the phView [out] parameter points to is set.

ERROR_INVALID_HANDLE, ERROR_INVALID_HANDLE_STATE, ERROR_BAD_QUERY_SYNTAX or ERROR_GEN_FAILURE if failure, and sets the error record, accessible via MsiGetLastErrorRecord.

Remarks

The MsiDatabaseOpenView function opens a view object for a database. You must open a view object for a database before performing any execution or fetching.

If an error occurs, you can call MsiGetLastErrorRecord for more information.

Note that it is recommended to use variables of type PMSIHANDLE because the installer closes PMSIHANDLE objects as they go out of scope, whereas you must close MSIHANDLE objects by calling MsiCloseHandle. For more information see Use PMSIHANDLE instead of HANDLE section in the Windows Installer Best Practices.

If the function fails, you can obtain extended error information by using MsiGetLastErrorRecord.

Requirements

See also

General Database Access Functions