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

MsiLocateComponentW

関数
現在の製品コンテキストでコンポーネントのパスと状態を取得する。
DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

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

INSTALLSTATE MsiLocateComponentW(
    LPCWSTR szComponent,
    LPWSTR lpPathBuf,   // optional
    DWORD* pcchBuf   // optional
);

パラメーター

名前方向説明
szComponentLPCWSTRin検索対象となるコンポーネントのコンポーネント ID を指定します。
lpPathBufLPWSTRoutoptionalコンポーネントへのパスを受け取る変数へのポインターです。この変数には終端の null 文字が含まれます。
pcchBufDWORD*inoutoptional

lpPathBuf パラメーターが指すバッファーのサイズ (文字数) を指定する変数へのポインターです。入力時には、終端の null 文字用の領域を含むバッファー全体のサイズを指定します。 MsiLocateComponent 関数が成功すると、pcchBuf が指す変数には、終端の null 文字を含まない文字数が格納されます。渡されたバッファーのサイズが小さすぎる場合、この関数は INSTALLSTATE_MOREDATA を返します。

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

戻り値の型: INSTALLSTATE

公式ドキュメント

MsiLocateComponent 関数は、製品コードを指定せずに、インストール済みコンポーネントへのフルパスを返します。(Unicode)

戻り値

意味
INSTALLSTATE_NOTUSED
要求されたコンポーネントは、このコンピューター上で無効になっています。
INSTALLSTATE_ABSENT
コンポーネントがインストールされていません。「解説」を参照してください。
INSTALLSTATE_INVALIDARG
関数のパラメーターのいずれかが無効です。
INSTALLSTATE_LOCAL
コンポーネントはローカルにインストールされています。
INSTALLSTATE_MOREDATA
指定されたバッファーが小さすぎました。
INSTALLSTATE_SOURCE
コンポーネントはソースから実行するようにインストールされています。
INSTALLSTATE_SOURCEABSENT
コンポーネントのソースにアクセスできません。
INSTALLSTATE_UNKNOWN
製品コードまたはコンポーネント ID が不明です。「解説」を参照してください。

解説(Remarks)

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

メモ

msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiLocateComponent を定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、コンパイルエラーまたは実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、「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>

INSTALLSTATE MsiLocateComponentW(
    LPCWSTR szComponent,
    LPWSTR lpPathBuf,   // optional
    DWORD* pcchBuf   // optional
);
[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int MsiLocateComponentW(
    [MarshalAs(UnmanagedType.LPWStr)] string szComponent,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpPathBuf,   // LPWSTR optional, out
    IntPtr pcchBuf   // DWORD* optional, in/out
);
<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiLocateComponentW(
    <MarshalAs(UnmanagedType.LPWStr)> szComponent As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpPathBuf As System.Text.StringBuilder,   ' LPWSTR optional, out
    pcchBuf As IntPtr   ' DWORD* optional, in/out
) As Integer
End Function
' szComponent : LPCWSTR
' lpPathBuf : LPWSTR optional, out
' pcchBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiLocateComponentW Lib "msi" ( _
    ByVal szComponent As LongPtr, _
    ByVal lpPathBuf As LongPtr, _
    ByVal pcchBuf As LongPtr) 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

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

lib = Fiddle.dlopen('msi.dll')
MsiLocateComponentW = Fiddle::Function.new(
  lib['MsiLocateComponentW'],
  [
    Fiddle::TYPE_VOIDP,  # szComponent : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpPathBuf : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchBuf : DWORD* optional, in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "msi")]
extern "system" {
    fn MsiLocateComponentW(
        szComponent: *const u16,  // LPCWSTR
        lpPathBuf: *mut u16,  // LPWSTR 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.Unicode)]
public static extern int MsiLocateComponentW([MarshalAs(UnmanagedType.LPWStr)] string szComponent, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpPathBuf, IntPtr pcchBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiLocateComponentW' -Namespace Win32 -PassThru
# $api::MsiLocateComponentW(szComponent, lpPathBuf, pcchBuf)
#uselib "msi.dll"
#func global MsiLocateComponentW "MsiLocateComponentW" wptr, wptr, wptr
; MsiLocateComponentW szComponent, varptr(lpPathBuf), varptr(pcchBuf)   ; 戻り値は stat
; szComponent : LPCWSTR -> "wptr"
; lpPathBuf : LPWSTR optional, out -> "wptr"
; pcchBuf : DWORD* optional, in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "msi.dll"
#cfunc global MsiLocateComponentW "MsiLocateComponentW" wstr, var, var
; res = MsiLocateComponentW(szComponent, lpPathBuf, pcchBuf)
; szComponent : LPCWSTR -> "wstr"
; lpPathBuf : LPWSTR optional, out -> "var"
; pcchBuf : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INSTALLSTATE MsiLocateComponentW(LPCWSTR szComponent, LPWSTR lpPathBuf, DWORD* pcchBuf)
#uselib "msi.dll"
#cfunc global MsiLocateComponentW "MsiLocateComponentW" wstr, var, var
; res = MsiLocateComponentW(szComponent, lpPathBuf, pcchBuf)
; szComponent : LPCWSTR -> "wstr"
; lpPathBuf : LPWSTR optional, out -> "var"
; pcchBuf : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiLocateComponentW = msi.NewProc("MsiLocateComponentW")
)

// szComponent (LPCWSTR), lpPathBuf (LPWSTR optional, out), pcchBuf (DWORD* optional, in/out)
r1, _, err := procMsiLocateComponentW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szComponent))),
	uintptr(lpPathBuf),
	uintptr(pcchBuf),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INSTALLSTATE
function MsiLocateComponentW(
  szComponent: PWideChar;   // LPCWSTR
  lpPathBuf: PWideChar;   // LPWSTR optional, out
  pcchBuf: Pointer   // DWORD* optional, in/out
): Integer; stdcall;
  external 'msi.dll' name 'MsiLocateComponentW';
result := DllCall("msi\MsiLocateComponentW"
    , "WStr", szComponent   ; LPCWSTR
    , "Ptr", lpPathBuf   ; LPWSTR optional, out
    , "Ptr", pcchBuf   ; DWORD* optional, in/out
    , "Int")   ; return: INSTALLSTATE
●MsiLocateComponentW(szComponent, lpPathBuf, pcchBuf) = DLL("msi.dll", "int MsiLocateComponentW(char*, char*, void*)")
# 呼び出し: MsiLocateComponentW(szComponent, lpPathBuf, pcchBuf)
# szComponent : LPCWSTR -> "char*"
# lpPathBuf : LPWSTR optional, out -> "char*"
# pcchBuf : DWORD* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "msi" fn MsiLocateComponentW(
    szComponent: [*c]const u16, // LPCWSTR
    lpPathBuf: [*c]u16, // LPWSTR optional, out
    pcchBuf: [*c]u32 // DWORD* optional, in/out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc MsiLocateComponentW(
    szComponent: WideCString,  # LPCWSTR
    lpPathBuf: ptr uint16,  # LPWSTR optional, out
    pcchBuf: ptr uint32  # DWORD* optional, in/out
): int32 {.importc: "MsiLocateComponentW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "msi");
extern(Windows)
int MsiLocateComponentW(
    const(wchar)* szComponent,   // LPCWSTR
    wchar* lpPathBuf,   // LPWSTR optional, out
    uint* pcchBuf   // DWORD* optional, in/out
);
ccall((:MsiLocateComponentW, "msi.dll"), stdcall, Int32,
      (Cwstring, Ptr{UInt16}, Ptr{UInt32}),
      szComponent, lpPathBuf, pcchBuf)
# szComponent : LPCWSTR -> Cwstring
# lpPathBuf : LPWSTR optional, out -> Ptr{UInt16}
# pcchBuf : DWORD* optional, in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t MsiLocateComponentW(
    const uint16_t* szComponent,
    uint16_t* lpPathBuf,
    uint32_t* pcchBuf);
]]
local msi = ffi.load("msi")
-- msi.MsiLocateComponentW(szComponent, lpPathBuf, pcchBuf)
-- szComponent : LPCWSTR
-- lpPathBuf : LPWSTR optional, out
-- pcchBuf : DWORD* optional, in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiLocateComponentW = lib.func('__stdcall', 'MsiLocateComponentW', 'int32_t', ['str16', 'uint16_t *', 'uint32_t *']);
// MsiLocateComponentW(szComponent, lpPathBuf, pcchBuf)
// szComponent : LPCWSTR -> 'str16'
// lpPathBuf : LPWSTR optional, out -> 'uint16_t *'
// pcchBuf : DWORD* optional, in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiLocateComponentW: { parameters: ["buffer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.MsiLocateComponentW(szComponent, lpPathBuf, pcchBuf)
// szComponent : LPCWSTR -> "buffer"
// lpPathBuf : LPWSTR optional, out -> "buffer"
// pcchBuf : DWORD* optional, in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t MsiLocateComponentW(
    const uint16_t* szComponent,
    uint16_t* lpPathBuf,
    uint32_t* pcchBuf);
C, "msi.dll");
// $ffi->MsiLocateComponentW(szComponent, lpPathBuf, pcchBuf);
// szComponent : LPCWSTR
// lpPathBuf : LPWSTR 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.UNICODE_OPTIONS);
    int MsiLocateComponentW(
        WString szComponent,   // LPCWSTR
        char[] lpPathBuf,   // LPWSTR optional, out
        IntByReference pcchBuf   // DWORD* optional, in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("msi")]
lib Libmsi
  fun MsiLocateComponentW = MsiLocateComponentW(
    szComponent : UInt16*,   # LPCWSTR
    lpPathBuf : UInt16*,   # LPWSTR 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 MsiLocateComponentWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint32>);
typedef MsiLocateComponentWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint32>);
final MsiLocateComponentW = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiLocateComponentWNative, MsiLocateComponentWDart>('MsiLocateComponentW');
// szComponent : LPCWSTR -> Pointer<Utf16>
// lpPathBuf : LPWSTR optional, out -> Pointer<Utf16>
// pcchBuf : DWORD* optional, in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiLocateComponentW(
  szComponent: PWideChar;   // LPCWSTR
  lpPathBuf: PWideChar;   // LPWSTR optional, out
  pcchBuf: Pointer   // DWORD* optional, in/out
): Integer; stdcall;
  external 'msi.dll' name 'MsiLocateComponentW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let msilocatecomponentw =
  foreign "MsiLocateComponentW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning int32_t)
(* szComponent : LPCWSTR -> (ptr uint16_t) *)
(* lpPathBuf : LPWSTR optional, out -> (ptr uint16_t) *)
(* 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 ("MsiLocateComponentW" msi-locate-component-w :convention :stdcall) :int32
  (sz-component (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-path-buf :pointer)   ; LPWSTR 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 $MsiLocateComponentW = Win32::API::More->new('msi',
    'int MsiLocateComponentW(LPCWSTR szComponent, LPWSTR lpPathBuf, LPVOID pcchBuf)');
# my $ret = $MsiLocateComponentW->Call($szComponent, $lpPathBuf, $pcchBuf);
# szComponent : LPCWSTR -> LPCWSTR
# lpPathBuf : LPWSTR optional, out -> LPWSTR
# pcchBuf : DWORD* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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