ホーム › System.ApplicationInstallationAndServicing › MsiDatabaseOpenViewW

MsiDatabaseOpenViewW

関数

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

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

シグネチャ

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiDatabaseOpenViewW(
    MSIHANDLE hDatabase,
    LPCWSTR szQuery,
    MSIHANDLE* phView
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

解説(Remarks)

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

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

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

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

メモ

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

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

各言語での呼び出し定義

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiDatabaseOpenViewW(
    MSIHANDLE hDatabase,
    LPCWSTR szQuery,
    MSIHANDLE* phView
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiDatabaseOpenViewW(
    uint hDatabase,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string szQuery,   // LPCWSTR
    ref uint phView   // MSIHANDLE* in/out
);

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

' hDatabase : MSIHANDLE
' szQuery : LPCWSTR
' phView : MSIHANDLE* in/out
Declare PtrSafe Function MsiDatabaseOpenViewW Lib "msi" ( _
    ByVal hDatabase As Long, _
    ByVal szQuery As LongPtr, _
    ByRef phView As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiDatabaseOpenViewW = Fiddle::Function.new(
  lib['MsiDatabaseOpenViewW'],
  [
    -Fiddle::TYPE_INT,  # hDatabase : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szQuery : LPCWSTR
    Fiddle::TYPE_VOIDP,  # phView : MSIHANDLE* in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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