ホーム › System.ApplicationInstallationAndServicing › MsiGetFeatureValidStatesW
MsiGetFeatureValidStatesW
関数機能が取り得る有効なインストール状態を取得する(Unicode版)。
シグネチャ
// msi.dll (Unicode / -W)
#include <windows.h>
DWORD MsiGetFeatureValidStatesW(
MSIHANDLE hInstall,
LPCWSTR szFeature,
DWORD* lpInstallStates
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| hInstall | MSIHANDLE | in | DLL カスタムアクションに渡されたインストールへのハンドル、または MsiOpenPackage、MsiOpenPackageEx、MsiOpenProduct によって取得されたハンドルを指定します。 | ||||||||||||
| szFeature | LPCWSTR | in | フィーチャー名を指定します。 | ||||||||||||
| lpInstallStates | DWORD* | inout | 有効なインストール状態を保持する場所を受け取ります。インストーラーは、有効なインストール状態ごとに pInstallState を次の値の組み合わせに設定します。このパラメーターを null にすることはできません。
|
戻り値の型: DWORD
公式ドキュメント
MsiGetFeatureValidStates 関数は有効なインストール状態を返します。(Unicode)
戻り値
MsiGetFeatureValidStates 関数は次の値を返します。
解説(Remarks)
Calling Database Functions From Programs を参照してください。
MsiGetFeatureValidStates 関数は、指定されたフィーチャーにリンクされたすべてのコンポーネントを照会することで状態の有効性を判定します。このとき、各コンポーネントの現在のインストール状態は考慮されません。
フィーチャーに対して有効となり得る状態は、次のように決定されます。
- フィーチャーがコンポーネントを含まない場合、INSTALLSTATE_LOCAL と INSTALLSTATE_SOURCE の両方がそのフィーチャーの有効な状態になります。
- フィーチャーのコンポーネントのうち少なくとも 1 つが msidbComponentAttributesLocalOnly または msidbComponentAttributesOptional 属性を持つ場合、INSTALLSTATE_LOCAL がそのフィーチャーの有効な状態になります。
- フィーチャーのコンポーネントのうち少なくとも 1 つが msidbComponentAttributesSourceOnly または msidbComponentAttributesOptional 属性を持つ場合、INSTALLSTATE_SOURCE がそのフィーチャーの有効な状態になります。
- フィーチャーに属するコンポーネントのファイルがパッチ適用されている場合、または圧縮されたソースに由来する場合、INSTALLSTATE_SOURCE はそのフィーチャーの有効な状態に含まれません。
- フィーチャーがアドバタイズを許可しない場合(msidbFeatureAttributesDisallowAdvertise)、またはフィーチャーがアドバタイズにプラットフォームのサポートを必要とし(msidbFeatureAttributesNoUnsupportedAdvertise)、かつプラットフォームがそれをサポートしていない場合、INSTALLSTATE_ADVERTISE は有効な状態ではありません。
- フィーチャーの属性に msidbFeatureAttributesUIDisallowAbsent が含まれていない場合、INSTALLSTATE_ABSENT はそのフィーチャーの有効な状態になります。
- 親フィーチャーに従うようにマークされた子フィーチャー(msidbFeatureAttributesFollowParent)の有効な状態は、親フィーチャーのアクションまたはインストール状態に基づきます。
MsiGetFeatureValidStates(hProduct, "Feature1", &dwValidStates);
Feature1 が値 0(ローカルを優先)の属性を持ち、Feature1 が値 0(ローカルのみ)の属性を持つコンポーネントを 1 つ持つ場合、呼び出し後の dwValidStates の値は 14 になります。これは、INSTALLSTATE_LOCAL、INSTALLSTATE_ABSENT、INSTALLSTATE_ADVERTISED がこの Feature1 の有効な状態であることを示します。次の条件文は、ローカルがこのフィーチャーの有効な状態である場合に True と評価されます。
( ( dwValidStates & ( 1 << INSTALLSTATE_LOCAL ) ) == ( 1 << INSTALLSTATE_LOCAL ) )
関数が失敗した場合は、MsiGetLastErrorRecord を使用して拡張エラー情報を取得できます。
メモ
msiquery.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiGetFeatureValidStates を定義します。エンコード中立のエイリアスの使用を、エンコード中立でないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// msi.dll (Unicode / -W)
#include <windows.h>
DWORD MsiGetFeatureValidStatesW(
MSIHANDLE hInstall,
LPCWSTR szFeature,
DWORD* lpInstallStates
);[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiGetFeatureValidStatesW(
uint hInstall, // MSIHANDLE
[MarshalAs(UnmanagedType.LPWStr)] string szFeature, // LPCWSTR
ref uint lpInstallStates // DWORD* in/out
);<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiGetFeatureValidStatesW(
hInstall As UInteger, ' MSIHANDLE
<MarshalAs(UnmanagedType.LPWStr)> szFeature As String, ' LPCWSTR
ByRef lpInstallStates As UInteger ' DWORD* in/out
) As UInteger
End Function' hInstall : MSIHANDLE
' szFeature : LPCWSTR
' lpInstallStates : DWORD* in/out
Declare PtrSafe Function MsiGetFeatureValidStatesW Lib "msi" ( _
ByVal hInstall As Long, _
ByVal szFeature As LongPtr, _
ByRef lpInstallStates 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
MsiGetFeatureValidStatesW = ctypes.windll.msi.MsiGetFeatureValidStatesW
MsiGetFeatureValidStatesW.restype = wintypes.DWORD
MsiGetFeatureValidStatesW.argtypes = [
wintypes.DWORD, # hInstall : MSIHANDLE
wintypes.LPCWSTR, # szFeature : LPCWSTR
ctypes.POINTER(wintypes.DWORD), # lpInstallStates : DWORD* in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('msi.dll')
MsiGetFeatureValidStatesW = Fiddle::Function.new(
lib['MsiGetFeatureValidStatesW'],
[
-Fiddle::TYPE_INT, # hInstall : MSIHANDLE
Fiddle::TYPE_VOIDP, # szFeature : LPCWSTR
Fiddle::TYPE_VOIDP, # lpInstallStates : DWORD* in/out
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "msi")]
extern "system" {
fn MsiGetFeatureValidStatesW(
hInstall: u32, // MSIHANDLE
szFeature: *const u16, // LPCWSTR
lpInstallStates: *mut u32 // DWORD* in/out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiGetFeatureValidStatesW(uint hInstall, [MarshalAs(UnmanagedType.LPWStr)] string szFeature, ref uint lpInstallStates);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetFeatureValidStatesW' -Namespace Win32 -PassThru
# $api::MsiGetFeatureValidStatesW(hInstall, szFeature, lpInstallStates)#uselib "msi.dll"
#func global MsiGetFeatureValidStatesW "MsiGetFeatureValidStatesW" wptr, wptr, wptr
; MsiGetFeatureValidStatesW hInstall, szFeature, varptr(lpInstallStates) ; 戻り値は stat
; hInstall : MSIHANDLE -> "wptr"
; szFeature : LPCWSTR -> "wptr"
; lpInstallStates : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "msi.dll" #cfunc global MsiGetFeatureValidStatesW "MsiGetFeatureValidStatesW" int, wstr, var ; res = MsiGetFeatureValidStatesW(hInstall, szFeature, lpInstallStates) ; hInstall : MSIHANDLE -> "int" ; szFeature : LPCWSTR -> "wstr" ; lpInstallStates : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll" #cfunc global MsiGetFeatureValidStatesW "MsiGetFeatureValidStatesW" int, wstr, sptr ; res = MsiGetFeatureValidStatesW(hInstall, szFeature, varptr(lpInstallStates)) ; hInstall : MSIHANDLE -> "int" ; szFeature : LPCWSTR -> "wstr" ; lpInstallStates : DWORD* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; DWORD MsiGetFeatureValidStatesW(MSIHANDLE hInstall, LPCWSTR szFeature, DWORD* lpInstallStates) #uselib "msi.dll" #cfunc global MsiGetFeatureValidStatesW "MsiGetFeatureValidStatesW" int, wstr, var ; res = MsiGetFeatureValidStatesW(hInstall, szFeature, lpInstallStates) ; hInstall : MSIHANDLE -> "int" ; szFeature : LPCWSTR -> "wstr" ; lpInstallStates : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD MsiGetFeatureValidStatesW(MSIHANDLE hInstall, LPCWSTR szFeature, DWORD* lpInstallStates) #uselib "msi.dll" #cfunc global MsiGetFeatureValidStatesW "MsiGetFeatureValidStatesW" int, wstr, intptr ; res = MsiGetFeatureValidStatesW(hInstall, szFeature, varptr(lpInstallStates)) ; hInstall : MSIHANDLE -> "int" ; szFeature : LPCWSTR -> "wstr" ; lpInstallStates : DWORD* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
msi = windows.NewLazySystemDLL("msi.dll")
procMsiGetFeatureValidStatesW = msi.NewProc("MsiGetFeatureValidStatesW")
)
// hInstall (MSIHANDLE), szFeature (LPCWSTR), lpInstallStates (DWORD* in/out)
r1, _, err := procMsiGetFeatureValidStatesW.Call(
uintptr(hInstall),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szFeature))),
uintptr(lpInstallStates),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction MsiGetFeatureValidStatesW(
hInstall: DWORD; // MSIHANDLE
szFeature: PWideChar; // LPCWSTR
lpInstallStates: Pointer // DWORD* in/out
): DWORD; stdcall;
external 'msi.dll' name 'MsiGetFeatureValidStatesW';result := DllCall("msi\MsiGetFeatureValidStatesW"
, "UInt", hInstall ; MSIHANDLE
, "WStr", szFeature ; LPCWSTR
, "Ptr", lpInstallStates ; DWORD* in/out
, "UInt") ; return: DWORD●MsiGetFeatureValidStatesW(hInstall, szFeature, lpInstallStates) = DLL("msi.dll", "dword MsiGetFeatureValidStatesW(dword, char*, void*)")
# 呼び出し: MsiGetFeatureValidStatesW(hInstall, szFeature, lpInstallStates)
# hInstall : MSIHANDLE -> "dword"
# szFeature : LPCWSTR -> "char*"
# lpInstallStates : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "msi" fn MsiGetFeatureValidStatesW(
hInstall: u32, // MSIHANDLE
szFeature: [*c]const u16, // LPCWSTR
lpInstallStates: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc MsiGetFeatureValidStatesW(
hInstall: uint32, # MSIHANDLE
szFeature: WideCString, # LPCWSTR
lpInstallStates: ptr uint32 # DWORD* in/out
): uint32 {.importc: "MsiGetFeatureValidStatesW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "msi");
extern(Windows)
uint MsiGetFeatureValidStatesW(
uint hInstall, // MSIHANDLE
const(wchar)* szFeature, // LPCWSTR
uint* lpInstallStates // DWORD* in/out
);ccall((:MsiGetFeatureValidStatesW, "msi.dll"), stdcall, UInt32,
(UInt32, Cwstring, Ptr{UInt32}),
hInstall, szFeature, lpInstallStates)
# hInstall : MSIHANDLE -> UInt32
# szFeature : LPCWSTR -> Cwstring
# lpInstallStates : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiGetFeatureValidStatesW(
uint32_t hInstall,
const uint16_t* szFeature,
uint32_t* lpInstallStates);
]]
local msi = ffi.load("msi")
-- msi.MsiGetFeatureValidStatesW(hInstall, szFeature, lpInstallStates)
-- hInstall : MSIHANDLE
-- szFeature : LPCWSTR
-- lpInstallStates : DWORD* 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 MsiGetFeatureValidStatesW = lib.func('__stdcall', 'MsiGetFeatureValidStatesW', 'uint32_t', ['uint32_t', 'str16', 'uint32_t *']);
// MsiGetFeatureValidStatesW(hInstall, szFeature, lpInstallStates)
// hInstall : MSIHANDLE -> 'uint32_t'
// szFeature : LPCWSTR -> 'str16'
// lpInstallStates : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("msi.dll", {
MsiGetFeatureValidStatesW: { parameters: ["u32", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.MsiGetFeatureValidStatesW(hInstall, szFeature, lpInstallStates)
// hInstall : MSIHANDLE -> "u32"
// szFeature : LPCWSTR -> "buffer"
// lpInstallStates : DWORD* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiGetFeatureValidStatesW(
uint32_t hInstall,
const uint16_t* szFeature,
uint32_t* lpInstallStates);
C, "msi.dll");
// $ffi->MsiGetFeatureValidStatesW(hInstall, szFeature, lpInstallStates);
// hInstall : MSIHANDLE
// szFeature : LPCWSTR
// lpInstallStates : DWORD* 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 MsiGetFeatureValidStatesW(
int hInstall, // MSIHANDLE
WString szFeature, // LPCWSTR
IntByReference lpInstallStates // DWORD* in/out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("msi")]
lib Libmsi
fun MsiGetFeatureValidStatesW = MsiGetFeatureValidStatesW(
hInstall : UInt32, # MSIHANDLE
szFeature : UInt16*, # LPCWSTR
lpInstallStates : UInt32* # DWORD* in/out
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef MsiGetFeatureValidStatesWNative = Uint32 Function(Uint32, Pointer<Utf16>, Pointer<Uint32>);
typedef MsiGetFeatureValidStatesWDart = int Function(int, Pointer<Utf16>, Pointer<Uint32>);
final MsiGetFeatureValidStatesW = DynamicLibrary.open('msi.dll')
.lookupFunction<MsiGetFeatureValidStatesWNative, MsiGetFeatureValidStatesWDart>('MsiGetFeatureValidStatesW');
// hInstall : MSIHANDLE -> Uint32
// szFeature : LPCWSTR -> Pointer<Utf16>
// lpInstallStates : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function MsiGetFeatureValidStatesW(
hInstall: DWORD; // MSIHANDLE
szFeature: PWideChar; // LPCWSTR
lpInstallStates: Pointer // DWORD* in/out
): DWORD; stdcall;
external 'msi.dll' name 'MsiGetFeatureValidStatesW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MsiGetFeatureValidStatesW"
c_MsiGetFeatureValidStatesW :: Word32 -> CWString -> Ptr Word32 -> IO Word32
-- hInstall : MSIHANDLE -> Word32
-- szFeature : LPCWSTR -> CWString
-- lpInstallStates : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let msigetfeaturevalidstatesw =
foreign "MsiGetFeatureValidStatesW"
(uint32_t @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* hInstall : MSIHANDLE -> uint32_t *)
(* szFeature : LPCWSTR -> (ptr uint16_t) *)
(* lpInstallStates : DWORD* 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 ("MsiGetFeatureValidStatesW" msi-get-feature-valid-states-w :convention :stdcall) :uint32
(h-install :uint32) ; MSIHANDLE
(sz-feature (:string :encoding :utf-16le)) ; LPCWSTR
(lp-install-states :pointer)) ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $MsiGetFeatureValidStatesW = Win32::API::More->new('msi',
'DWORD MsiGetFeatureValidStatesW(DWORD hInstall, LPCWSTR szFeature, LPVOID lpInstallStates)');
# my $ret = $MsiGetFeatureValidStatesW->Call($hInstall, $szFeature, $lpInstallStates);
# hInstall : MSIHANDLE -> DWORD
# szFeature : LPCWSTR -> LPCWSTR
# lpInstallStates : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f MsiGetFeatureValidStatesA (ANSI版) — 機能が取り得る有効なインストール状態を取得する(ANSI版)。