Win32 API 日本語リファレンス
ホームSystem.ApplicationInstallationAndServicing › MsiQueryComponentStateA

MsiQueryComponentStateA

関数
指定したコンポーネントのインストール状態を問い合わせて取得する。
DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiQueryComponentStateA(
    LPCSTR szProductCode,
    LPCSTR szUserSid,   // optional
    MSIINSTALLCONTEXT dwContext,
    LPCSTR szComponentCode,
    INSTALLSTATE* pdwState   // optional
);

パラメーター

名前方向説明
szProductCodeLPCSTRinコンポーネントを含む製品の ProductCode GUID を指定します。
szUserSidLPCSTRinoptional

照会対象の製品インスタンスが存在するアカウントのセキュリティ識別子 (SID) を指定します。dwContextMSIINSTALLCONTEXT_MACHINE でない場合、null は現在のユーザーを指定します。

SID の種類 意味
NULL
NULL は現在ログオンしているユーザーを表します。
User SID
システム内の特定のユーザーに対する列挙を指定します。ユーザー SID の例は "S-1-3-64-2415071341-1358098788-3127455600-2561" です。
注意 特殊な SID 文字列 "S-1-5-18" (system) は、コンピューター単位でインストールされた製品の列挙には使用できません。dwContextMSIINSTALLCONTEXT_MACHINE の場合、szUserSid は null でなければなりません。
dwContextMSIINSTALLCONTEXTin

照会対象の製品インスタンスのインストールコンテキストです。

名前 意味
MSIINSTALLCONTEXT_USERMANAGED
製品のユーザー単位の管理されたインスタンスについて、コンポーネントの状態を取得します。
MSIINSTALLCONTEXT_USERUNMANAGED
製品のユーザー単位の管理されていないインスタンスについて、コンポーネントの状態を取得します。
MSIINSTALLCONTEXT_MACHINE
製品のコンピューター単位のインスタンスについて、コンポーネントの状態を取得します。
szComponentCodeLPCSTRin照会対象のコンポーネントを指定します。Component テーブルの ComponentID 列にあるコンポーネントのコンポーネントコード GUID です。
pdwStateINSTALLSTATE*outoptional

指定した製品インスタンスにおけるコンポーネントのインストール状態です。このパラメーターは、以下のいずれかの値または null 値を返します。

意味
INSTALLSTATE_LOCAL
コンポーネントはローカルにインストールされています。
INSTALLSTATE_SOURCE
コンポーネントはソースから実行されるようにインストールされています。

戻り値の型: DWORD

公式ドキュメント

MsiQueryComponentState 関数は、コンポーネントのインストール状態を返します。(ANSI)

戻り値

MsiQueryComponentState 関数は、以下の値を返します。

意味
ERROR_ACCESS_DENIED
現在のユーザー以外のユーザー向けにインストールされた製品の情報を取得するには、呼び出しプロセスに管理者特権が必要です。
ERROR_BAD_CONFIGURATION
構成データが破損しています。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。
ERROR_SUCCESS
関数は正常に完了しました。
ERROR_UNKNOWN_COMPONENT
コンポーネント ID が既知のコンポーネントを示していません。
ERROR_UNKNOWN_PRODUCT
製品コードが既知の製品を示していません。
ERROR_FUNCTION_FAILED
いずれの Windows エラーコードにも帰属できない失敗です。
ERROR_MORE_DATA
ユーザー SID を取得するにはバッファーが小さすぎます。

詳細については、Displayed Error Messages を参照してください。

解説(Remarks)

メモ

msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiQueryComponentState を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が発生し、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、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 MsiQueryComponentStateA(
    LPCSTR szProductCode,
    LPCSTR szUserSid,   // optional
    MSIINSTALLCONTEXT dwContext,
    LPCSTR szComponentCode,
    INSTALLSTATE* pdwState   // optional
);
[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiQueryComponentStateA(
    [MarshalAs(UnmanagedType.LPStr)] string szProductCode,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szUserSid,   // LPCSTR optional
    int dwContext,   // MSIINSTALLCONTEXT
    [MarshalAs(UnmanagedType.LPStr)] string szComponentCode,   // LPCSTR
    IntPtr pdwState   // INSTALLSTATE* optional, out
);
<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiQueryComponentStateA(
    <MarshalAs(UnmanagedType.LPStr)> szProductCode As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szUserSid As String,   ' LPCSTR optional
    dwContext As Integer,   ' MSIINSTALLCONTEXT
    <MarshalAs(UnmanagedType.LPStr)> szComponentCode As String,   ' LPCSTR
    pdwState As IntPtr   ' INSTALLSTATE* optional, out
) As UInteger
End Function
' szProductCode : LPCSTR
' szUserSid : LPCSTR optional
' dwContext : MSIINSTALLCONTEXT
' szComponentCode : LPCSTR
' pdwState : INSTALLSTATE* optional, out
Declare PtrSafe Function MsiQueryComponentStateA Lib "msi" ( _
    ByVal szProductCode As String, _
    ByVal szUserSid As String, _
    ByVal dwContext As Long, _
    ByVal szComponentCode As String, _
    ByVal pdwState As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiQueryComponentStateA = ctypes.windll.msi.MsiQueryComponentStateA
MsiQueryComponentStateA.restype = wintypes.DWORD
MsiQueryComponentStateA.argtypes = [
    wintypes.LPCSTR,  # szProductCode : LPCSTR
    wintypes.LPCSTR,  # szUserSid : LPCSTR optional
    ctypes.c_int,  # dwContext : MSIINSTALLCONTEXT
    wintypes.LPCSTR,  # szComponentCode : LPCSTR
    ctypes.c_void_p,  # pdwState : INSTALLSTATE* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiQueryComponentStateA = Fiddle::Function.new(
  lib['MsiQueryComponentStateA'],
  [
    Fiddle::TYPE_VOIDP,  # szProductCode : LPCSTR
    Fiddle::TYPE_VOIDP,  # szUserSid : LPCSTR optional
    Fiddle::TYPE_INT,  # dwContext : MSIINSTALLCONTEXT
    Fiddle::TYPE_VOIDP,  # szComponentCode : LPCSTR
    Fiddle::TYPE_VOIDP,  # pdwState : INSTALLSTATE* optional, out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiQueryComponentStateA(
        szProductCode: *const u8,  // LPCSTR
        szUserSid: *const u8,  // LPCSTR optional
        dwContext: i32,  // MSIINSTALLCONTEXT
        szComponentCode: *const u8,  // LPCSTR
        pdwState: *mut i32  // INSTALLSTATE* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiQueryComponentStateA([MarshalAs(UnmanagedType.LPStr)] string szProductCode, [MarshalAs(UnmanagedType.LPStr)] string szUserSid, int dwContext, [MarshalAs(UnmanagedType.LPStr)] string szComponentCode, IntPtr pdwState);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiQueryComponentStateA' -Namespace Win32 -PassThru
# $api::MsiQueryComponentStateA(szProductCode, szUserSid, dwContext, szComponentCode, pdwState)
#uselib "msi.dll"
#func global MsiQueryComponentStateA "MsiQueryComponentStateA" sptr, sptr, sptr, sptr, sptr
; MsiQueryComponentStateA szProductCode, szUserSid, dwContext, szComponentCode, varptr(pdwState)   ; 戻り値は stat
; szProductCode : LPCSTR -> "sptr"
; szUserSid : LPCSTR optional -> "sptr"
; dwContext : MSIINSTALLCONTEXT -> "sptr"
; szComponentCode : LPCSTR -> "sptr"
; pdwState : INSTALLSTATE* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "msi.dll"
#cfunc global MsiQueryComponentStateA "MsiQueryComponentStateA" str, str, int, str, var
; res = MsiQueryComponentStateA(szProductCode, szUserSid, dwContext, szComponentCode, pdwState)
; szProductCode : LPCSTR -> "str"
; szUserSid : LPCSTR optional -> "str"
; dwContext : MSIINSTALLCONTEXT -> "int"
; szComponentCode : LPCSTR -> "str"
; pdwState : INSTALLSTATE* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD MsiQueryComponentStateA(LPCSTR szProductCode, LPCSTR szUserSid, MSIINSTALLCONTEXT dwContext, LPCSTR szComponentCode, INSTALLSTATE* pdwState)
#uselib "msi.dll"
#cfunc global MsiQueryComponentStateA "MsiQueryComponentStateA" str, str, int, str, var
; res = MsiQueryComponentStateA(szProductCode, szUserSid, dwContext, szComponentCode, pdwState)
; szProductCode : LPCSTR -> "str"
; szUserSid : LPCSTR optional -> "str"
; dwContext : MSIINSTALLCONTEXT -> "int"
; szComponentCode : LPCSTR -> "str"
; pdwState : INSTALLSTATE* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiQueryComponentStateA = msi.NewProc("MsiQueryComponentStateA")
)

// szProductCode (LPCSTR), szUserSid (LPCSTR optional), dwContext (MSIINSTALLCONTEXT), szComponentCode (LPCSTR), pdwState (INSTALLSTATE* optional, out)
r1, _, err := procMsiQueryComponentStateA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szProductCode))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szUserSid))),
	uintptr(dwContext),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szComponentCode))),
	uintptr(pdwState),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiQueryComponentStateA(
  szProductCode: PAnsiChar;   // LPCSTR
  szUserSid: PAnsiChar;   // LPCSTR optional
  dwContext: Integer;   // MSIINSTALLCONTEXT
  szComponentCode: PAnsiChar;   // LPCSTR
  pdwState: Pointer   // INSTALLSTATE* optional, out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiQueryComponentStateA';
result := DllCall("msi\MsiQueryComponentStateA"
    , "AStr", szProductCode   ; LPCSTR
    , "AStr", szUserSid   ; LPCSTR optional
    , "Int", dwContext   ; MSIINSTALLCONTEXT
    , "AStr", szComponentCode   ; LPCSTR
    , "Ptr", pdwState   ; INSTALLSTATE* optional, out
    , "UInt")   ; return: DWORD
●MsiQueryComponentStateA(szProductCode, szUserSid, dwContext, szComponentCode, pdwState) = DLL("msi.dll", "dword MsiQueryComponentStateA(char*, char*, int, char*, void*)")
# 呼び出し: MsiQueryComponentStateA(szProductCode, szUserSid, dwContext, szComponentCode, pdwState)
# szProductCode : LPCSTR -> "char*"
# szUserSid : LPCSTR optional -> "char*"
# dwContext : MSIINSTALLCONTEXT -> "int"
# szComponentCode : LPCSTR -> "char*"
# pdwState : INSTALLSTATE* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "msi" fn MsiQueryComponentStateA(
    szProductCode: [*c]const u8, // LPCSTR
    szUserSid: [*c]const u8, // LPCSTR optional
    dwContext: i32, // MSIINSTALLCONTEXT
    szComponentCode: [*c]const u8, // LPCSTR
    pdwState: [*c]i32 // INSTALLSTATE* optional, out
) callconv(std.os.windows.WINAPI) u32;
proc MsiQueryComponentStateA(
    szProductCode: cstring,  # LPCSTR
    szUserSid: cstring,  # LPCSTR optional
    dwContext: int32,  # MSIINSTALLCONTEXT
    szComponentCode: cstring,  # LPCSTR
    pdwState: ptr int32  # INSTALLSTATE* optional, out
): uint32 {.importc: "MsiQueryComponentStateA", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiQueryComponentStateA(
    const(char)* szProductCode,   // LPCSTR
    const(char)* szUserSid,   // LPCSTR optional
    int dwContext,   // MSIINSTALLCONTEXT
    const(char)* szComponentCode,   // LPCSTR
    int* pdwState   // INSTALLSTATE* optional, out
);
ccall((:MsiQueryComponentStateA, "msi.dll"), stdcall, UInt32,
      (Cstring, Cstring, Int32, Cstring, Ptr{Int32}),
      szProductCode, szUserSid, dwContext, szComponentCode, pdwState)
# szProductCode : LPCSTR -> Cstring
# szUserSid : LPCSTR optional -> Cstring
# dwContext : MSIINSTALLCONTEXT -> Int32
# szComponentCode : LPCSTR -> Cstring
# pdwState : INSTALLSTATE* optional, out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiQueryComponentStateA(
    const char* szProductCode,
    const char* szUserSid,
    int32_t dwContext,
    const char* szComponentCode,
    int32_t* pdwState);
]]
local msi = ffi.load("msi")
-- msi.MsiQueryComponentStateA(szProductCode, szUserSid, dwContext, szComponentCode, pdwState)
-- szProductCode : LPCSTR
-- szUserSid : LPCSTR optional
-- dwContext : MSIINSTALLCONTEXT
-- szComponentCode : LPCSTR
-- pdwState : INSTALLSTATE* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiQueryComponentStateA = lib.func('__stdcall', 'MsiQueryComponentStateA', 'uint32_t', ['str', 'str', 'int32_t', 'str', 'int32_t *']);
// MsiQueryComponentStateA(szProductCode, szUserSid, dwContext, szComponentCode, pdwState)
// szProductCode : LPCSTR -> 'str'
// szUserSid : LPCSTR optional -> 'str'
// dwContext : MSIINSTALLCONTEXT -> 'int32_t'
// szComponentCode : LPCSTR -> 'str'
// pdwState : INSTALLSTATE* optional, out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiQueryComponentStateA: { parameters: ["buffer", "buffer", "i32", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.MsiQueryComponentStateA(szProductCode, szUserSid, dwContext, szComponentCode, pdwState)
// szProductCode : LPCSTR -> "buffer"
// szUserSid : LPCSTR optional -> "buffer"
// dwContext : MSIINSTALLCONTEXT -> "i32"
// szComponentCode : LPCSTR -> "buffer"
// pdwState : INSTALLSTATE* optional, out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiQueryComponentStateA(
    const char* szProductCode,
    const char* szUserSid,
    int32_t dwContext,
    const char* szComponentCode,
    int32_t* pdwState);
C, "msi.dll");
// $ffi->MsiQueryComponentStateA(szProductCode, szUserSid, dwContext, szComponentCode, pdwState);
// szProductCode : LPCSTR
// szUserSid : LPCSTR optional
// dwContext : MSIINSTALLCONTEXT
// szComponentCode : LPCSTR
// pdwState : INSTALLSTATE* optional, out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Msi extends StdCallLibrary {
    Msi INSTANCE = Native.load("msi", Msi.class, W32APIOptions.ASCII_OPTIONS);
    int MsiQueryComponentStateA(
        String szProductCode,   // LPCSTR
        String szUserSid,   // LPCSTR optional
        int dwContext,   // MSIINSTALLCONTEXT
        String szComponentCode,   // LPCSTR
        IntByReference pdwState   // INSTALLSTATE* optional, out
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiQueryComponentStateA = MsiQueryComponentStateA(
    szProductCode : UInt8*,   # LPCSTR
    szUserSid : UInt8*,   # LPCSTR optional
    dwContext : Int32,   # MSIINSTALLCONTEXT
    szComponentCode : UInt8*,   # LPCSTR
    pdwState : Int32*   # INSTALLSTATE* optional, out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiQueryComponentStateANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Int32, Pointer<Utf8>, Pointer<Int32>);
typedef MsiQueryComponentStateADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, Pointer<Utf8>, Pointer<Int32>);
final MsiQueryComponentStateA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiQueryComponentStateANative, MsiQueryComponentStateADart>('MsiQueryComponentStateA');
// szProductCode : LPCSTR -> Pointer<Utf8>
// szUserSid : LPCSTR optional -> Pointer<Utf8>
// dwContext : MSIINSTALLCONTEXT -> Int32
// szComponentCode : LPCSTR -> Pointer<Utf8>
// pdwState : INSTALLSTATE* optional, out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiQueryComponentStateA(
  szProductCode: PAnsiChar;   // LPCSTR
  szUserSid: PAnsiChar;   // LPCSTR optional
  dwContext: Integer;   // MSIINSTALLCONTEXT
  szComponentCode: PAnsiChar;   // LPCSTR
  pdwState: Pointer   // INSTALLSTATE* optional, out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiQueryComponentStateA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiQueryComponentStateA"
  c_MsiQueryComponentStateA :: CString -> CString -> Int32 -> CString -> Ptr Int32 -> IO Word32
-- szProductCode : LPCSTR -> CString
-- szUserSid : LPCSTR optional -> CString
-- dwContext : MSIINSTALLCONTEXT -> Int32
-- szComponentCode : LPCSTR -> CString
-- pdwState : INSTALLSTATE* optional, out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msiquerycomponentstatea =
  foreign "MsiQueryComponentStateA"
    (string @-> string @-> int32_t @-> string @-> (ptr int32_t) @-> returning uint32_t)
(* szProductCode : LPCSTR -> string *)
(* szUserSid : LPCSTR optional -> string *)
(* dwContext : MSIINSTALLCONTEXT -> int32_t *)
(* szComponentCode : LPCSTR -> string *)
(* pdwState : INSTALLSTATE* optional, out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiQueryComponentStateA" msi-query-component-state-a :convention :stdcall) :uint32
  (sz-product-code :string)   ; LPCSTR
  (sz-user-sid :string)   ; LPCSTR optional
  (dw-context :int32)   ; MSIINSTALLCONTEXT
  (sz-component-code :string)   ; LPCSTR
  (pdw-state :pointer))   ; INSTALLSTATE* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiQueryComponentStateA = Win32::API::More->new('msi',
    'DWORD MsiQueryComponentStateA(LPCSTR szProductCode, LPCSTR szUserSid, int dwContext, LPCSTR szComponentCode, LPVOID pdwState)');
# my $ret = $MsiQueryComponentStateA->Call($szProductCode, $szUserSid, $dwContext, $szComponentCode, $pdwState);
# szProductCode : LPCSTR -> LPCSTR
# szUserSid : LPCSTR optional -> LPCSTR
# dwContext : MSIINSTALLCONTEXT -> int
# szComponentCode : LPCSTR -> LPCSTR
# pdwState : INSTALLSTATE* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型