ホーム › System.ApplicationInstallationAndServicing › MsiGetComponentStateW

MsiGetComponentStateW

関数

コンポーネントの現在の状態と要求された状態を取得する(Unicode版)。

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

シグネチャ

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

DWORD MsiGetComponentStateW(
    MSIHANDLE hInstall,
    LPCWSTR szComponent,
    INSTALLSTATE* piInstalled,
    INSTALLSTATE* piAction
);

パラメーター

名前

型

方向

説明

hInstall

MSIHANDLE

DLL カスタムアクションに渡された、または MsiOpenPackage、MsiOpenPackageEx、MsiOpenProduct によって取得したインストールへのハンドルです。

szComponent

LPCWSTR

製品内のコンポーネント名を指定する、null で終わる文字列です。

piInstalled

INSTALLSTATE*

inout

現在のインストール状態を受け取ります。このパラメーターを null にすることはできません。このパラメーターには次のいずれかの値を指定できます。

値	意味
INSTALLSTATE_ABSENT	コンポーネントはインストールされていません。
INSTALLSTATE_DEFAULT	コンポーネントは既定の場所(ローカルまたはソース)にインストールされています。
INSTALLSTATE_LOCAL	コンポーネントはローカルドライブにインストールされています。
INSTALLSTATE_REMOVED	コンポーネントは削除中です。アクション状態であり、設定はできません。
INSTALLSTATE_SOURCE	コンポーネントはソース、CD-ROM、またはネットワークから実行されます。
INSTALLSTATE_UNKNOWN	認識されない製品名または機能名が関数に渡されました。

piAction

INSTALLSTATE*

inout

インストール中に実行されるアクションを受け取ります。このパラメーターを null にすることはできません。戻り値については piInstalled を参照してください。

戻り値の型: DWORD

公式ドキュメント

MsiGetComponentState 関数は、コンポーネントの状態を取得します。(Unicode)

戻り値

MsiGetComponentState 関数は次の値を返します。

解説(Remarks)

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

詳細については、プログラムからのデータベース関数の呼び出しを参照してください。

メモ

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

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

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiGetComponentStateW(
    uint hInstall,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string szComponent,   // LPCWSTR
    ref int piInstalled,   // INSTALLSTATE* in/out
    ref int piAction   // INSTALLSTATE* in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiGetComponentStateW(
    hInstall As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPWStr)> szComponent As String,   ' LPCWSTR
    ByRef piInstalled As Integer,   ' INSTALLSTATE* in/out
    ByRef piAction As Integer   ' INSTALLSTATE* in/out
) As UInteger
End Function

' hInstall : MSIHANDLE
' szComponent : LPCWSTR
' piInstalled : INSTALLSTATE* in/out
' piAction : INSTALLSTATE* in/out
Declare PtrSafe Function MsiGetComponentStateW Lib "msi" ( _
    ByVal hInstall As Long, _
    ByVal szComponent As LongPtr, _
    ByRef piInstalled As Long, _
    ByRef piAction 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

MsiGetComponentStateW = ctypes.windll.msi.MsiGetComponentStateW
MsiGetComponentStateW.restype = wintypes.DWORD
MsiGetComponentStateW.argtypes = [
    wintypes.DWORD,  # hInstall : MSIHANDLE
    wintypes.LPCWSTR,  # szComponent : LPCWSTR
    ctypes.c_void_p,  # piInstalled : INSTALLSTATE* in/out
    ctypes.c_void_p,  # piAction : INSTALLSTATE* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiGetComponentStateW = Fiddle::Function.new(
  lib['MsiGetComponentStateW'],
  [
    -Fiddle::TYPE_INT,  # hInstall : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szComponent : LPCWSTR
    Fiddle::TYPE_VOIDP,  # piInstalled : INSTALLSTATE* in/out
    Fiddle::TYPE_VOIDP,  # piAction : INSTALLSTATE* in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "msi")]
extern "system" {
    fn MsiGetComponentStateW(
        hInstall: u32,  // MSIHANDLE
        szComponent: *const u16,  // LPCWSTR
        piInstalled: *mut i32,  // INSTALLSTATE* in/out
        piAction: *mut i32  // INSTALLSTATE* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiGetComponentStateW(uint hInstall, [MarshalAs(UnmanagedType.LPWStr)] string szComponent, ref int piInstalled, ref int piAction);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetComponentStateW' -Namespace Win32 -PassThru
# $api::MsiGetComponentStateW(hInstall, szComponent, piInstalled, piAction)

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

出力引数:

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