ホーム › System.ApplicationInstallationAndServicing › MsiOpenProductW

MsiOpenProductW

関数

インストール済み製品をクエリ用に開いてハンドルを取得する。

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

シグネチャ

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

DWORD MsiOpenProductW(
    LPCWSTR szProduct,
    MSIHANDLE* hProduct
);

パラメーター

名前	型	方向	説明
szProduct	LPCWSTR	in	開く製品の製品コードを指定します。
hProduct	MSIHANDLE*	out	製品ハンドルを受け取る変数へのポインターです。

戻り値の型: DWORD

公式ドキュメント

MsiOpenProduct 関数は、製品データベースにアクセスする関数で使用するために製品を開きます。ハンドルが不要になったら、そのハンドルを指定して MsiCloseHandle 関数を呼び出す必要があります。(Unicode)

戻り値

値	意味
ERROR_BAD_CONFIGURATION	構成情報が破損しています。
ERROR_INSTALL_FAILURE	製品を開けませんでした。
ERROR_INSTALL_SOURCE_ABSENT	ソースが利用できませんでした。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。
ERROR_SUCCESS	関数は正常に完了しました。
ERROR_UNKNOWN_PRODUCT	製品コードが認識されませんでした。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiOpenProductW(
    LPCWSTR szProduct,
    MSIHANDLE* hProduct
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiOpenProductW(
    [MarshalAs(UnmanagedType.LPWStr)] string szProduct,   // LPCWSTR
    out uint hProduct   // MSIHANDLE* out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiOpenProductW(
    <MarshalAs(UnmanagedType.LPWStr)> szProduct As String,   ' LPCWSTR
    <Out> ByRef hProduct As UInteger   ' MSIHANDLE* out
) As UInteger
End Function

' szProduct : LPCWSTR
' hProduct : MSIHANDLE* out
Declare PtrSafe Function MsiOpenProductW Lib "msi" ( _
    ByVal szProduct As LongPtr, _
    ByRef hProduct 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

MsiOpenProductW = ctypes.windll.msi.MsiOpenProductW
MsiOpenProductW.restype = wintypes.DWORD
MsiOpenProductW.argtypes = [
    wintypes.LPCWSTR,  # szProduct : LPCWSTR
    ctypes.c_void_p,  # hProduct : MSIHANDLE* out
]

require 'fiddle'
require 'fiddle/import'

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

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

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiOpenProductW([MarshalAs(UnmanagedType.LPWStr)] string szProduct, out uint hProduct);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiOpenProductW' -Namespace Win32 -PassThru
# $api::MsiOpenProductW(szProduct, hProduct)

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

出力引数:

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