ホーム › System.ApplicationInstallationAndServicing › MsiDatabaseOpenViewA

MsiDatabaseOpenViewA

関数

インストールデータベースに対するSQLクエリのビューを開く。

DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

// msi.dll  (ANSI / -A)
#include <windows.h>

DWORD MsiDatabaseOpenViewA(
    MSIHANDLE hDatabase,
    LPCSTR szQuery,
    MSIHANDLE* phView
);

パラメーター

名前	型	方向	説明
hDatabase	MSIHANDLE	in	ビューオブジェクトを開く対象のデータベースへのハンドルです。ハンドルの取得方法については、Obtaining a Database Handle を参照してください。
szQuery	LPCSTR	in	データベースを照会するための SQL クエリ文字列を指定します。正しい構文については、 SQL Syntax を参照してください。
phView	MSIHANDLE*	inout	返されるビューのハンドルへのポインターです。

戻り値の型: DWORD

公式ドキュメント

MsiDatabaseOpenView 関数はデータベースクエリを準備し、ビューオブジェクトを作成します。この関数は、MsiCloseHandle を使用して閉じる必要があるハンドルを返します。(ANSI)

戻り値

MsiDatabaseOpenView 関数は、次のいずれかの値を返します。

成功した場合は ERROR_SUCCESS が返され、phView [out] パラメーターが指すビューハンドルが設定されます。

失敗した場合は ERROR_INVALID_HANDLE、ERROR_INVALID_HANDLE_STATE、ERROR_BAD_QUERY_SYNTAX、または ERROR_GEN_FAILURE が返され、MsiGetLastErrorRecord を介してアクセス可能なエラーレコードが設定されます。

解説(Remarks)

MsiDatabaseOpenView 関数は、データベースのビューオブジェクトを開きます。実行やフェッチを行う前に、データベースのビューオブジェクトを開く必要があります。

エラーが発生した場合は、 MsiGetLastErrorRecord を呼び出すことで詳細情報を取得できます。

PMSIHANDLE 型の変数を使用することをお勧めします。これは、インストーラーが PMSIHANDLE オブジェクトをスコープ外になった時点で閉じるのに対し、MSIHANDLE オブジェクトは MsiCloseHandle を呼び出して閉じる必要があるためです。詳細については、Windows Installer Best Practices の Use PMSIHANDLE instead of HANDLE セクションを参照してください。

関数が失敗した場合は、MsiGetLastErrorRecord を使用して拡張エラー情報を取得できます。

メモ

msiquery.h ヘッダーは、MsiDatabaseOpenView を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディングに依存しないこのエイリアスの使用を、エンコーディングに依存しないわけではないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// msi.dll  (ANSI / -A)
#include <windows.h>

DWORD MsiDatabaseOpenViewA(
    MSIHANDLE hDatabase,
    LPCSTR szQuery,
    MSIHANDLE* phView
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiDatabaseOpenViewA(
    uint hDatabase,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPStr)] string szQuery,   // LPCSTR
    ref uint phView   // MSIHANDLE* in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiDatabaseOpenViewA(
    hDatabase As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPStr)> szQuery As String,   ' LPCSTR
    ByRef phView As UInteger   ' MSIHANDLE* in/out
) As UInteger
End Function

' hDatabase : MSIHANDLE
' szQuery : LPCSTR
' phView : MSIHANDLE* in/out
Declare PtrSafe Function MsiDatabaseOpenViewA Lib "msi" ( _
    ByVal hDatabase As Long, _
    ByVal szQuery As String, _
    ByRef phView As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiDatabaseOpenViewA = ctypes.windll.msi.MsiDatabaseOpenViewA
MsiDatabaseOpenViewA.restype = wintypes.DWORD
MsiDatabaseOpenViewA.argtypes = [
    wintypes.DWORD,  # hDatabase : MSIHANDLE
    wintypes.LPCSTR,  # szQuery : LPCSTR
    ctypes.c_void_p,  # phView : MSIHANDLE* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiDatabaseOpenViewA = Fiddle::Function.new(
  lib['MsiDatabaseOpenViewA'],
  [
    -Fiddle::TYPE_INT,  # hDatabase : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szQuery : LPCSTR
    Fiddle::TYPE_VOIDP,  # phView : MSIHANDLE* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiDatabaseOpenViewA(
        hDatabase: u32,  // MSIHANDLE
        szQuery: *const u8,  // LPCSTR
        phView: *mut u32  // MSIHANDLE* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiDatabaseOpenViewA(uint hDatabase, [MarshalAs(UnmanagedType.LPStr)] string szQuery, ref uint phView);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiDatabaseOpenViewA' -Namespace Win32 -PassThru
# $api::MsiDatabaseOpenViewA(hDatabase, szQuery, phView)

#uselib "msi.dll"
#func global MsiDatabaseOpenViewA "MsiDatabaseOpenViewA" sptr, sptr, sptr
; MsiDatabaseOpenViewA hDatabase, szQuery, varptr(phView)   ; 戻り値は stat
; hDatabase : MSIHANDLE -> "sptr"
; szQuery : LPCSTR -> "sptr"
; phView : MSIHANDLE* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msi.dll"
#cfunc global MsiDatabaseOpenViewA "MsiDatabaseOpenViewA" int, str, var
; res = MsiDatabaseOpenViewA(hDatabase, szQuery, phView)
; hDatabase : MSIHANDLE -> "int"
; szQuery : LPCSTR -> "str"
; phView : MSIHANDLE* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiDatabaseOpenViewA "MsiDatabaseOpenViewA" int, str, sptr
; res = MsiDatabaseOpenViewA(hDatabase, szQuery, varptr(phView))
; hDatabase : MSIHANDLE -> "int"
; szQuery : LPCSTR -> "str"
; phView : MSIHANDLE* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。