MsiLocateComponentA
関数シグネチャ
// msi.dll (ANSI / -A)
#include <windows.h>
INSTALLSTATE MsiLocateComponentA(
LPCSTR szComponent,
LPSTR lpPathBuf, // optional
DWORD* pcchBuf // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| szComponent | LPCSTR | in | 検索するコンポーネントのコンポーネント ID を指定します。 |
| lpPathBuf | LPSTR | outoptional | コンポーネントへのパスを受け取る変数へのポインター。この変数には終端の null 文字が含まれます。 |
| pcchBuf | DWORD* | inoutoptional | lpPathBuf パラメーターが指すバッファーのサイズ(文字数単位)を指定する変数へのポインター。入力時には、終端の null 文字用の領域を含めたバッファーの全サイズを指定します。 MsiLocateComponent 関数が成功すると、pcchBuf が指す変数には、終端の null 文字を含まない文字数が格納されます。渡されたバッファーのサイズが小さすぎる場合、この関数は INSTALLSTATE_MOREDATA を返します。 lpPathBuf が null の場合、pcchBuf も null にできます。 |
戻り値の型: INSTALLSTATE
公式ドキュメント
MsiLocateComponent 関数は、製品コードを指定せずに、インストール済みコンポーネントへのフルパスを返します。(ANSI)
戻り値
| 値 | 意味 |
|---|---|
| 要求されたコンポーネントはこのコンピューター上で無効になっています。 | |
| コンポーネントがインストールされていません。「解説」を参照してください。 | |
| 関数のパラメーターのいずれかが無効です。 | |
| コンポーネントはローカルにインストールされています。 | |
| 指定されたバッファーが小さすぎました。 | |
| コンポーネントはソースから実行するようにインストールされています。 | |
| コンポーネントのソースにアクセスできません。 | |
| 製品コードまたはコンポーネント ID が不明です。「解説」を参照してください。 |
解説(Remarks)
MsiLocateComponent 関数は、次の理由により INSTALLSTATE_ABSENT または INSTALL_STATE_UNKNOWN を返すことがあります。
- INSTALLSTATE_ABSENT
アプリケーションが MsiUseFeature を呼び出し、必要に応じて MsiConfigureFeature を呼び出すことで、機能がインストールされていることを適切に確認しませんでした。
- INSTALLSTATE_UNKNOWN
機能が発行されていません。アプリケーションは、これより前に MsiQueryFeatureState または MsiEnumFeatures を呼び出して、この状態を確認しておくべきでした。アプリケーションは、初期化中にこれらの呼び出しを行います。アプリケーションは、発行されていることが判明している機能のみを使用すべきです。INSTALLSTATE_UNKNOWN は MsiUseFeature によっても返されるはずなので、MsiUseFeature が呼び出されなかったか、またはその戻り値が適切にチェックされなかったことになります。
msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiLocateComponent を定義します。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// msi.dll (ANSI / -A)
#include <windows.h>
INSTALLSTATE MsiLocateComponentA(
LPCSTR szComponent,
LPSTR lpPathBuf, // optional
DWORD* pcchBuf // optional
);[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int MsiLocateComponentA(
[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 MsiLocateComponentA(
<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' szComponent : LPCSTR
' lpPathBuf : LPSTR optional, out
' pcchBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiLocateComponentA Lib "msi" ( _
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
MsiLocateComponentA = ctypes.windll.msi.MsiLocateComponentA
MsiLocateComponentA.restype = ctypes.c_int
MsiLocateComponentA.argtypes = [
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')
MsiLocateComponentA = Fiddle::Function.new(
lib['MsiLocateComponentA'],
[
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 MsiLocateComponentA(
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 MsiLocateComponentA([MarshalAs(UnmanagedType.LPStr)] string szComponent, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpPathBuf, IntPtr pcchBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiLocateComponentA' -Namespace Win32 -PassThru
# $api::MsiLocateComponentA(szComponent, lpPathBuf, pcchBuf)#uselib "msi.dll"
#func global MsiLocateComponentA "MsiLocateComponentA" sptr, sptr, sptr
; MsiLocateComponentA szComponent, varptr(lpPathBuf), varptr(pcchBuf) ; 戻り値は stat
; szComponent : LPCSTR -> "sptr"
; lpPathBuf : LPSTR optional, out -> "sptr"
; pcchBuf : DWORD* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "msi.dll" #cfunc global MsiLocateComponentA "MsiLocateComponentA" str, var, var ; res = MsiLocateComponentA(szComponent, lpPathBuf, pcchBuf) ; szComponent : LPCSTR -> "str" ; lpPathBuf : LPSTR optional, out -> "var" ; pcchBuf : DWORD* optional, in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll" #cfunc global MsiLocateComponentA "MsiLocateComponentA" str, sptr, sptr ; res = MsiLocateComponentA(szComponent, varptr(lpPathBuf), varptr(pcchBuf)) ; szComponent : LPCSTR -> "str" ; lpPathBuf : LPSTR optional, out -> "sptr" ; pcchBuf : DWORD* optional, in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; INSTALLSTATE MsiLocateComponentA(LPCSTR szComponent, LPSTR lpPathBuf, DWORD* pcchBuf) #uselib "msi.dll" #cfunc global MsiLocateComponentA "MsiLocateComponentA" str, var, var ; res = MsiLocateComponentA(szComponent, lpPathBuf, pcchBuf) ; szComponent : LPCSTR -> "str" ; lpPathBuf : LPSTR optional, out -> "var" ; pcchBuf : DWORD* optional, in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; INSTALLSTATE MsiLocateComponentA(LPCSTR szComponent, LPSTR lpPathBuf, DWORD* pcchBuf) #uselib "msi.dll" #cfunc global MsiLocateComponentA "MsiLocateComponentA" str, intptr, intptr ; res = MsiLocateComponentA(szComponent, varptr(lpPathBuf), varptr(pcchBuf)) ; szComponent : LPCSTR -> "str" ; lpPathBuf : LPSTR optional, out -> "intptr" ; pcchBuf : DWORD* optional, in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
msi = windows.NewLazySystemDLL("msi.dll")
procMsiLocateComponentA = msi.NewProc("MsiLocateComponentA")
)
// szComponent (LPCSTR), lpPathBuf (LPSTR optional, out), pcchBuf (DWORD* optional, in/out)
r1, _, err := procMsiLocateComponentA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(szComponent))),
uintptr(lpPathBuf),
uintptr(pcchBuf),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INSTALLSTATEfunction MsiLocateComponentA(
szComponent: PAnsiChar; // LPCSTR
lpPathBuf: PAnsiChar; // LPSTR optional, out
pcchBuf: Pointer // DWORD* optional, in/out
): Integer; stdcall;
external 'msi.dll' name 'MsiLocateComponentA';result := DllCall("msi\MsiLocateComponentA"
, "AStr", szComponent ; LPCSTR
, "Ptr", lpPathBuf ; LPSTR optional, out
, "Ptr", pcchBuf ; DWORD* optional, in/out
, "Int") ; return: INSTALLSTATE●MsiLocateComponentA(szComponent, lpPathBuf, pcchBuf) = DLL("msi.dll", "int MsiLocateComponentA(char*, char*, void*)")
# 呼び出し: MsiLocateComponentA(szComponent, lpPathBuf, pcchBuf)
# 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 MsiLocateComponentA(
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 MsiLocateComponentA(
szComponent: cstring, # LPCSTR
lpPathBuf: ptr char, # LPSTR optional, out
pcchBuf: ptr uint32 # DWORD* optional, in/out
): int32 {.importc: "MsiLocateComponentA", stdcall, dynlib: "msi.dll".}pragma(lib, "msi");
extern(Windows)
int MsiLocateComponentA(
const(char)* szComponent, // LPCSTR
char* lpPathBuf, // LPSTR optional, out
uint* pcchBuf // DWORD* optional, in/out
);ccall((:MsiLocateComponentA, "msi.dll"), stdcall, Int32,
(Cstring, Ptr{UInt8}, Ptr{UInt32}),
szComponent, lpPathBuf, pcchBuf)
# 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 MsiLocateComponentA(
const char* szComponent,
char* lpPathBuf,
uint32_t* pcchBuf);
]]
local msi = ffi.load("msi")
-- msi.MsiLocateComponentA(szComponent, lpPathBuf, pcchBuf)
-- 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 MsiLocateComponentA = lib.func('__stdcall', 'MsiLocateComponentA', 'int32_t', ['str', 'char *', 'uint32_t *']);
// MsiLocateComponentA(szComponent, lpPathBuf, pcchBuf)
// 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", {
MsiLocateComponentA: { parameters: ["buffer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.MsiLocateComponentA(szComponent, lpPathBuf, pcchBuf)
// 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 MsiLocateComponentA(
const char* szComponent,
char* lpPathBuf,
uint32_t* pcchBuf);
C, "msi.dll");
// $ffi->MsiLocateComponentA(szComponent, lpPathBuf, pcchBuf);
// 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 MsiLocateComponentA(
String szComponent, // LPCSTR
byte[] lpPathBuf, // LPSTR optional, out
IntByReference pcchBuf // DWORD* optional, in/out
);
}@[Link("msi")]
lib Libmsi
fun MsiLocateComponentA = MsiLocateComponentA(
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 MsiLocateComponentANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>);
typedef MsiLocateComponentADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>);
final MsiLocateComponentA = DynamicLibrary.open('msi.dll')
.lookupFunction<MsiLocateComponentANative, MsiLocateComponentADart>('MsiLocateComponentA');
// 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 MsiLocateComponentA(
szComponent: PAnsiChar; // LPCSTR
lpPathBuf: PAnsiChar; // LPSTR optional, out
pcchBuf: Pointer // DWORD* optional, in/out
): Integer; stdcall;
external 'msi.dll' name 'MsiLocateComponentA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MsiLocateComponentA"
c_MsiLocateComponentA :: CString -> CString -> Ptr Word32 -> IO Int32
-- 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 msilocatecomponenta =
foreign "MsiLocateComponentA"
(string @-> string @-> (ptr uint32_t) @-> returning int32_t)
(* 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 ("MsiLocateComponentA" msi-locate-component-a :convention :stdcall) :int32
(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 $MsiLocateComponentA = Win32::API::More->new('msi',
'int MsiLocateComponentA(LPCSTR szComponent, LPSTR lpPathBuf, LPVOID pcchBuf)');
# my $ret = $MsiLocateComponentA->Call($szComponent, $lpPathBuf, $pcchBuf);
# szComponent : LPCSTR -> LPCSTR
# lpPathBuf : LPSTR optional, out -> LPSTR
# pcchBuf : DWORD* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f MsiLocateComponentW (Unicode版) — 現在の製品コンテキストでコンポーネントのパスと状態を取得する。