MsiSetFeatureStateA
関数シグネチャ
// msi.dll (ANSI / -A)
#include <windows.h>
DWORD MsiSetFeatureStateA(
MSIHANDLE hInstall,
LPCSTR szFeature,
INSTALLSTATE iState
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| hInstall | MSIHANDLE | in | DLL カスタムアクションに提供された、または MsiOpenPackage、MsiOpenPackageEx、MsiOpenProduct を通じて取得したインストールへのハンドルです。 | ||||||||||
| szFeature | LPCSTR | in | 機能の名前を指定します。 | ||||||||||
| iState | INSTALLSTATE | in | 設定する状態を指定します。このパラメーターには、次のいずれかの値を指定できます。
|
戻り値の型: DWORD
公式ドキュメント
MsiSetFeatureState 関数は、機能(フィーチャー)を指定した状態に設定します。(ANSI)
戻り値
MsiSetFeatureState 関数は、次の値を返します。
解説(Remarks)
MsiSetFeatureState 関数は、 Feature テーブル内の機能とその子の選択状態の変更を要求します。これに伴い、変更された機能レコードにリンクされたすべてのコンポーネントのアクション状態も、新しい機能の選択状態に基づいて適切に更新されます。
MsiSetFeatureState を呼び出す前に、 MsiSetInstallLevel 関数を呼び出す必要があります。
MsiSetFeatureState が呼び出されると、インストーラーは指定された機能に関連付けられた各コンポーネントのアクション状態を、指定された状態に設定しようとします。ただし、要求を完全には実装できない一般的な状況があります。たとえば、ある機能が FeatureComponents テーブルを通じて 2 つのコンポーネント(コンポーネント A とコンポーネント B)に関連付けられており、コンポーネント A が msidbComponentAttributesLocalOnly 属性を、コンポーネント B が msidbComponentAttributesSourceOnly 属性を持つ場合です。このケースで、要求された状態を INSTALLSTATE_LOCAL または INSTALLSTATE_SOURCE のいずれかとして MsiSetFeatureState を呼び出すと、両方のコンポーネントについて要求を完全には実装できません。この場合、両方のコンポーネントがオンになり、コンポーネント A は Local に、コンポーネント B は Source に設定されます。
複数の機能が単一のコンポーネントにリンクされている場合(よくあるシナリオ)、そのコンポーネントの最終的なアクション状態は次のように決定されます。
- 少なくとも 1 つの機能がコンポーネントのローカルインストールを必要とする場合、その機能は local の状態でインストールされます。
- 少なくとも 1 つの機能がコンポーネントをソースから実行することを必要とする場合、その機能は source の状態でインストールされます。
- 少なくとも 1 つの機能がコンポーネントの削除を必要とする場合、アクション状態は absent になります。
関数が失敗した場合は、MsiGetLastErrorRecord を使用して拡張エラー情報を取得できます。
msiquery.h ヘッダーは、MsiSetFeatureState を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、関数プロトタイプの規則を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// msi.dll (ANSI / -A)
#include <windows.h>
DWORD MsiSetFeatureStateA(
MSIHANDLE hInstall,
LPCSTR szFeature,
INSTALLSTATE iState
);[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiSetFeatureStateA(
uint hInstall, // MSIHANDLE
[MarshalAs(UnmanagedType.LPStr)] string szFeature, // LPCSTR
int iState // INSTALLSTATE
);<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiSetFeatureStateA(
hInstall As UInteger, ' MSIHANDLE
<MarshalAs(UnmanagedType.LPStr)> szFeature As String, ' LPCSTR
iState As Integer ' INSTALLSTATE
) As UInteger
End Function' hInstall : MSIHANDLE
' szFeature : LPCSTR
' iState : INSTALLSTATE
Declare PtrSafe Function MsiSetFeatureStateA Lib "msi" ( _
ByVal hInstall As Long, _
ByVal szFeature As String, _
ByVal iState As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
MsiSetFeatureStateA = ctypes.windll.msi.MsiSetFeatureStateA
MsiSetFeatureStateA.restype = wintypes.DWORD
MsiSetFeatureStateA.argtypes = [
wintypes.DWORD, # hInstall : MSIHANDLE
wintypes.LPCSTR, # szFeature : LPCSTR
ctypes.c_int, # iState : INSTALLSTATE
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('msi.dll')
MsiSetFeatureStateA = Fiddle::Function.new(
lib['MsiSetFeatureStateA'],
[
-Fiddle::TYPE_INT, # hInstall : MSIHANDLE
Fiddle::TYPE_VOIDP, # szFeature : LPCSTR
Fiddle::TYPE_INT, # iState : INSTALLSTATE
],
-Fiddle::TYPE_INT)#[link(name = "msi")]
extern "system" {
fn MsiSetFeatureStateA(
hInstall: u32, // MSIHANDLE
szFeature: *const u8, // LPCSTR
iState: i32 // INSTALLSTATE
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiSetFeatureStateA(uint hInstall, [MarshalAs(UnmanagedType.LPStr)] string szFeature, int iState);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiSetFeatureStateA' -Namespace Win32 -PassThru
# $api::MsiSetFeatureStateA(hInstall, szFeature, iState)#uselib "msi.dll"
#func global MsiSetFeatureStateA "MsiSetFeatureStateA" sptr, sptr, sptr
; MsiSetFeatureStateA hInstall, szFeature, iState ; 戻り値は stat
; hInstall : MSIHANDLE -> "sptr"
; szFeature : LPCSTR -> "sptr"
; iState : INSTALLSTATE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "msi.dll"
#cfunc global MsiSetFeatureStateA "MsiSetFeatureStateA" int, str, int
; res = MsiSetFeatureStateA(hInstall, szFeature, iState)
; hInstall : MSIHANDLE -> "int"
; szFeature : LPCSTR -> "str"
; iState : INSTALLSTATE -> "int"; DWORD MsiSetFeatureStateA(MSIHANDLE hInstall, LPCSTR szFeature, INSTALLSTATE iState)
#uselib "msi.dll"
#cfunc global MsiSetFeatureStateA "MsiSetFeatureStateA" int, str, int
; res = MsiSetFeatureStateA(hInstall, szFeature, iState)
; hInstall : MSIHANDLE -> "int"
; szFeature : LPCSTR -> "str"
; iState : INSTALLSTATE -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
msi = windows.NewLazySystemDLL("msi.dll")
procMsiSetFeatureStateA = msi.NewProc("MsiSetFeatureStateA")
)
// hInstall (MSIHANDLE), szFeature (LPCSTR), iState (INSTALLSTATE)
r1, _, err := procMsiSetFeatureStateA.Call(
uintptr(hInstall),
uintptr(unsafe.Pointer(windows.BytePtrFromString(szFeature))),
uintptr(iState),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction MsiSetFeatureStateA(
hInstall: DWORD; // MSIHANDLE
szFeature: PAnsiChar; // LPCSTR
iState: Integer // INSTALLSTATE
): DWORD; stdcall;
external 'msi.dll' name 'MsiSetFeatureStateA';result := DllCall("msi\MsiSetFeatureStateA"
, "UInt", hInstall ; MSIHANDLE
, "AStr", szFeature ; LPCSTR
, "Int", iState ; INSTALLSTATE
, "UInt") ; return: DWORD●MsiSetFeatureStateA(hInstall, szFeature, iState) = DLL("msi.dll", "dword MsiSetFeatureStateA(dword, char*, int)")
# 呼び出し: MsiSetFeatureStateA(hInstall, szFeature, iState)
# hInstall : MSIHANDLE -> "dword"
# szFeature : LPCSTR -> "char*"
# iState : INSTALLSTATE -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "msi" fn MsiSetFeatureStateA(
hInstall: u32, // MSIHANDLE
szFeature: [*c]const u8, // LPCSTR
iState: i32 // INSTALLSTATE
) callconv(std.os.windows.WINAPI) u32;proc MsiSetFeatureStateA(
hInstall: uint32, # MSIHANDLE
szFeature: cstring, # LPCSTR
iState: int32 # INSTALLSTATE
): uint32 {.importc: "MsiSetFeatureStateA", stdcall, dynlib: "msi.dll".}pragma(lib, "msi");
extern(Windows)
uint MsiSetFeatureStateA(
uint hInstall, // MSIHANDLE
const(char)* szFeature, // LPCSTR
int iState // INSTALLSTATE
);ccall((:MsiSetFeatureStateA, "msi.dll"), stdcall, UInt32,
(UInt32, Cstring, Int32),
hInstall, szFeature, iState)
# hInstall : MSIHANDLE -> UInt32
# szFeature : LPCSTR -> Cstring
# iState : INSTALLSTATE -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiSetFeatureStateA(
uint32_t hInstall,
const char* szFeature,
int32_t iState);
]]
local msi = ffi.load("msi")
-- msi.MsiSetFeatureStateA(hInstall, szFeature, iState)
-- hInstall : MSIHANDLE
-- szFeature : LPCSTR
-- iState : INSTALLSTATE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiSetFeatureStateA = lib.func('__stdcall', 'MsiSetFeatureStateA', 'uint32_t', ['uint32_t', 'str', 'int32_t']);
// MsiSetFeatureStateA(hInstall, szFeature, iState)
// hInstall : MSIHANDLE -> 'uint32_t'
// szFeature : LPCSTR -> 'str'
// iState : INSTALLSTATE -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("msi.dll", {
MsiSetFeatureStateA: { parameters: ["u32", "buffer", "i32"], result: "u32" },
});
// lib.symbols.MsiSetFeatureStateA(hInstall, szFeature, iState)
// hInstall : MSIHANDLE -> "u32"
// szFeature : LPCSTR -> "buffer"
// iState : INSTALLSTATE -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiSetFeatureStateA(
uint32_t hInstall,
const char* szFeature,
int32_t iState);
C, "msi.dll");
// $ffi->MsiSetFeatureStateA(hInstall, szFeature, iState);
// hInstall : MSIHANDLE
// szFeature : LPCSTR
// iState : INSTALLSTATE
// 構造体/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 MsiSetFeatureStateA(
int hInstall, // MSIHANDLE
String szFeature, // LPCSTR
int iState // INSTALLSTATE
);
}@[Link("msi")]
lib Libmsi
fun MsiSetFeatureStateA = MsiSetFeatureStateA(
hInstall : UInt32, # MSIHANDLE
szFeature : UInt8*, # LPCSTR
iState : Int32 # INSTALLSTATE
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef MsiSetFeatureStateANative = Uint32 Function(Uint32, Pointer<Utf8>, Int32);
typedef MsiSetFeatureStateADart = int Function(int, Pointer<Utf8>, int);
final MsiSetFeatureStateA = DynamicLibrary.open('msi.dll')
.lookupFunction<MsiSetFeatureStateANative, MsiSetFeatureStateADart>('MsiSetFeatureStateA');
// hInstall : MSIHANDLE -> Uint32
// szFeature : LPCSTR -> Pointer<Utf8>
// iState : INSTALLSTATE -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function MsiSetFeatureStateA(
hInstall: DWORD; // MSIHANDLE
szFeature: PAnsiChar; // LPCSTR
iState: Integer // INSTALLSTATE
): DWORD; stdcall;
external 'msi.dll' name 'MsiSetFeatureStateA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MsiSetFeatureStateA"
c_MsiSetFeatureStateA :: Word32 -> CString -> Int32 -> IO Word32
-- hInstall : MSIHANDLE -> Word32
-- szFeature : LPCSTR -> CString
-- iState : INSTALLSTATE -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let msisetfeaturestatea =
foreign "MsiSetFeatureStateA"
(uint32_t @-> string @-> int32_t @-> returning uint32_t)
(* hInstall : MSIHANDLE -> uint32_t *)
(* szFeature : LPCSTR -> string *)
(* iState : INSTALLSTATE -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)
(cffi:defcfun ("MsiSetFeatureStateA" msi-set-feature-state-a :convention :stdcall) :uint32
(h-install :uint32) ; MSIHANDLE
(sz-feature :string) ; LPCSTR
(i-state :int32)) ; INSTALLSTATE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $MsiSetFeatureStateA = Win32::API::More->new('msi',
'DWORD MsiSetFeatureStateA(DWORD hInstall, LPCSTR szFeature, int iState)');
# my $ret = $MsiSetFeatureStateA->Call($hInstall, $szFeature, $iState);
# hInstall : MSIHANDLE -> DWORD
# szFeature : LPCSTR -> LPCSTR
# iState : INSTALLSTATE -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f MsiSetFeatureStateW (Unicode版) — 機能のインストール状態を設定する(Unicode版)。