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

MsiGetComponentPathA

関数
製品とコンポーネントを指定してインストール済みパスと状態を取得する。
DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

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

INSTALLSTATE MsiGetComponentPathA(
    LPCSTR szProduct,
    LPCSTR szComponent,
    LPSTR lpPathBuf,   // optional
    DWORD* pcchBuf   // optional
);

パラメーター

名前方向説明
szProductLPCSTRinクライアント製品の製品コードを指定します。
szComponentLPCSTRin検索対象となるコンポーネントのコンポーネント ID を指定します。
lpPathBufLPSTRoutoptional

コンポーネントへのパスを受け取る変数へのポインターです。このパラメーターは null にできます。コンポーネントがレジストリキーである場合、レジストリのルートは数値で表されます。レジストリサブキーパスの場合は、キーパスの末尾に円記号が付きます。レジストリ値キーパスの場合は、末尾に円記号は付きません。たとえば、32 ビットオペレーティングシステム上のレジストリパス HKEY_CURRENT_USER\SOFTWARE\Microsoft は、"01:\SOFTWARE\Microsoft" として返されます。32 ビットオペレーティングシステムで返されるレジストリのルートは、次の表のとおり定義されています。

注意 64 ビットオペレーティングシステムでは、この表の数値で表されたレジストリルートに 20 が加算され、32 ビットオペレーティングシステム上のレジストリキーパスと区別されます。 たとえば、64 ビットオペレーティングシステムでコンポーネントパスがレジストリキーである場合、レジストリキーパス HKEY_CURRENT_USER\SOFTWARE\Microsoft は "21:\SOFTWARE\Microsoft\" として返されます。
ルート 意味
HKEY_CLASSES_ROOT
00
HKEY_CURRENT_USER
01
HKEY_LOCAL_MACHINE
02
HKEY_USERS
03
pcchBufDWORD*inoutoptional

lpPathBuf パラメーターが指すバッファーのサイズを文字数で指定する変数へのポインターです。入力時には、終端の null 文字用の領域を含むバッファー全体のサイズを指定します。渡されたバッファーが小さすぎる場合、返される文字数には終端の null 文字は含まれません。

lpPathBuf が null の場合、pcchBuf も null にできます。

戻り値の型: INSTALLSTATE

公式ドキュメント

MsiGetComponentPath 関数は、インストール済みコンポーネントへのフルパスを返します。コンポーネントのキーパスがレジストリキーである場合は、そのレジストリキーが返されます。(ANSI)

戻り値

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

意味
INSTALLSTATE_NOTUSED
要求されたコンポーネントは、コンピューター上で無効になっています。
INSTALLSTATE_ABSENT
コンポーネントがインストールされていません。
INSTALLSTATE_INVALIDARG
関数パラメーターのいずれかが無効です。
INSTALLSTATE_LOCAL
コンポーネントはローカルにインストールされています。
INSTALLSTATE_SOURCE
コンポーネントはソースから実行するようにインストールされています。
INSTALLSTATE_SOURCEABSENT
コンポーネントのソースにアクセスできません。
INSTALLSTATE_UNKNOWN
製品コードまたはコンポーネント ID が不明です。

解説(Remarks)

MsiGetComponentPath 関数が成功すると、pcchBuf パラメーターには lpPathBuf 内の文字列の長さが格納されます。

MsiGetComponentPath 関数は、次の理由により INSTALLSTATE_ABSENT または INSTALL_STATE_UNKNOWN を返すことがあります。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

INSTALLSTATE MsiGetComponentPathA(
    LPCSTR szProduct,
    LPCSTR szComponent,
    LPSTR lpPathBuf,   // optional
    DWORD* pcchBuf   // optional
);
[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int MsiGetComponentPathA(
    [MarshalAs(UnmanagedType.LPStr)] string szProduct,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szComponent,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpPathBuf,   // LPSTR optional, out
    IntPtr pcchBuf   // DWORD* optional, in/out
);
<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiGetComponentPathA(
    <MarshalAs(UnmanagedType.LPStr)> szProduct As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szComponent As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpPathBuf As System.Text.StringBuilder,   ' LPSTR optional, out
    pcchBuf As IntPtr   ' DWORD* optional, in/out
) As Integer
End Function
' szProduct : LPCSTR
' szComponent : LPCSTR
' lpPathBuf : LPSTR optional, out
' pcchBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiGetComponentPathA Lib "msi" ( _
    ByVal szProduct As String, _
    ByVal szComponent As String, _
    ByVal lpPathBuf As String, _
    ByVal pcchBuf As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiGetComponentPathA = ctypes.windll.msi.MsiGetComponentPathA
MsiGetComponentPathA.restype = ctypes.c_int
MsiGetComponentPathA.argtypes = [
    wintypes.LPCSTR,  # szProduct : LPCSTR
    wintypes.LPCSTR,  # szComponent : LPCSTR
    wintypes.LPSTR,  # lpPathBuf : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchBuf : DWORD* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiGetComponentPathA = msi.NewProc("MsiGetComponentPathA")
)

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

extern "msi" fn MsiGetComponentPathA(
    szProduct: [*c]const u8, // LPCSTR
    szComponent: [*c]const u8, // LPCSTR
    lpPathBuf: [*c]u8, // LPSTR optional, out
    pcchBuf: [*c]u32 // DWORD* optional, in/out
) callconv(std.os.windows.WINAPI) i32;
proc MsiGetComponentPathA(
    szProduct: cstring,  # LPCSTR
    szComponent: cstring,  # LPCSTR
    lpPathBuf: ptr char,  # LPSTR optional, out
    pcchBuf: ptr uint32  # DWORD* optional, in/out
): int32 {.importc: "MsiGetComponentPathA", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
int MsiGetComponentPathA(
    const(char)* szProduct,   // LPCSTR
    const(char)* szComponent,   // LPCSTR
    char* lpPathBuf,   // LPSTR optional, out
    uint* pcchBuf   // DWORD* optional, in/out
);
ccall((:MsiGetComponentPathA, "msi.dll"), stdcall, Int32,
      (Cstring, Cstring, Ptr{UInt8}, Ptr{UInt32}),
      szProduct, szComponent, lpPathBuf, pcchBuf)
# szProduct : LPCSTR -> Cstring
# szComponent : LPCSTR -> Cstring
# lpPathBuf : LPSTR optional, out -> Ptr{UInt8}
# pcchBuf : DWORD* optional, in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t MsiGetComponentPathA(
    const char* szProduct,
    const char* szComponent,
    char* lpPathBuf,
    uint32_t* pcchBuf);
]]
local msi = ffi.load("msi")
-- msi.MsiGetComponentPathA(szProduct, szComponent, lpPathBuf, pcchBuf)
-- szProduct : LPCSTR
-- szComponent : LPCSTR
-- lpPathBuf : LPSTR optional, out
-- pcchBuf : DWORD* optional, in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiGetComponentPathA = lib.func('__stdcall', 'MsiGetComponentPathA', 'int32_t', ['str', 'str', 'char *', 'uint32_t *']);
// MsiGetComponentPathA(szProduct, szComponent, lpPathBuf, pcchBuf)
// szProduct : LPCSTR -> 'str'
// szComponent : LPCSTR -> 'str'
// lpPathBuf : LPSTR optional, out -> 'char *'
// pcchBuf : DWORD* optional, in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiGetComponentPathA: { parameters: ["buffer", "buffer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.MsiGetComponentPathA(szProduct, szComponent, lpPathBuf, pcchBuf)
// szProduct : LPCSTR -> "buffer"
// szComponent : LPCSTR -> "buffer"
// lpPathBuf : LPSTR optional, out -> "buffer"
// pcchBuf : DWORD* optional, in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t MsiGetComponentPathA(
    const char* szProduct,
    const char* szComponent,
    char* lpPathBuf,
    uint32_t* pcchBuf);
C, "msi.dll");
// $ffi->MsiGetComponentPathA(szProduct, szComponent, lpPathBuf, pcchBuf);
// szProduct : LPCSTR
// szComponent : LPCSTR
// lpPathBuf : LPSTR optional, out
// pcchBuf : DWORD* optional, in/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 MsiGetComponentPathA(
        String szProduct,   // LPCSTR
        String szComponent,   // LPCSTR
        byte[] lpPathBuf,   // LPSTR optional, out
        IntByReference pcchBuf   // DWORD* optional, in/out
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiGetComponentPathA = MsiGetComponentPathA(
    szProduct : UInt8*,   # LPCSTR
    szComponent : UInt8*,   # LPCSTR
    lpPathBuf : UInt8*,   # LPSTR optional, out
    pcchBuf : UInt32*   # DWORD* optional, in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiGetComponentPathANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>);
typedef MsiGetComponentPathADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>);
final MsiGetComponentPathA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiGetComponentPathANative, MsiGetComponentPathADart>('MsiGetComponentPathA');
// szProduct : LPCSTR -> Pointer<Utf8>
// szComponent : LPCSTR -> Pointer<Utf8>
// lpPathBuf : LPSTR optional, out -> Pointer<Utf8>
// pcchBuf : DWORD* optional, in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiGetComponentPathA(
  szProduct: PAnsiChar;   // LPCSTR
  szComponent: PAnsiChar;   // LPCSTR
  lpPathBuf: PAnsiChar;   // LPSTR optional, out
  pcchBuf: Pointer   // DWORD* optional, in/out
): Integer; stdcall;
  external 'msi.dll' name 'MsiGetComponentPathA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiGetComponentPathA"
  c_MsiGetComponentPathA :: CString -> CString -> CString -> Ptr Word32 -> IO Int32
-- szProduct : LPCSTR -> CString
-- szComponent : LPCSTR -> CString
-- lpPathBuf : LPSTR optional, out -> CString
-- pcchBuf : DWORD* optional, in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msigetcomponentpatha =
  foreign "MsiGetComponentPathA"
    (string @-> string @-> string @-> (ptr uint32_t) @-> returning int32_t)
(* szProduct : LPCSTR -> string *)
(* szComponent : LPCSTR -> string *)
(* lpPathBuf : LPSTR optional, out -> string *)
(* pcchBuf : DWORD* optional, in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiGetComponentPathA" msi-get-component-path-a :convention :stdcall) :int32
  (sz-product :string)   ; LPCSTR
  (sz-component :string)   ; LPCSTR
  (lp-path-buf :pointer)   ; LPSTR optional, out
  (pcch-buf :pointer))   ; DWORD* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiGetComponentPathA = Win32::API::More->new('msi',
    'int MsiGetComponentPathA(LPCSTR szProduct, LPCSTR szComponent, LPSTR lpPathBuf, LPVOID pcchBuf)');
# my $ret = $MsiGetComponentPathA->Call($szProduct, $szComponent, $lpPathBuf, $pcchBuf);
# szProduct : LPCSTR -> LPCSTR
# szComponent : LPCSTR -> LPCSTR
# lpPathBuf : LPSTR optional, out -> LPSTR
# pcchBuf : DWORD* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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