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

MsiConfigureFeatureA

関数
機能のインストール状態を構成変更する(ANSI版)。
DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiConfigureFeatureA(
    LPCSTR szProduct,
    LPCSTR szFeature,
    INSTALLSTATE eInstallState
);

パラメーター

名前方向説明
szProductLPCSTRin構成する製品のプロダクトコードを指定します。
szFeatureLPCSTRin構成する機能の機能 ID を指定します。
eInstallStateINSTALLSTATEin

機能のインストール状態を指定します。このパラメーターには、次のいずれかの値を指定する必要があります。

意味
INSTALLSTATE_ADVERTISED
機能はアドバタイズされます。
INSTALLSTATE_LOCAL
機能はローカルにインストールされます。
INSTALLSTATE_ABSENT
機能はアンインストールされます。
INSTALLSTATE_SOURCE
機能はソースから実行するようにインストールされます。
INSTALLSTATE_DEFAULT
機能は既定の場所にインストールされます。

戻り値の型: DWORD

公式ドキュメント

MsiConfigureFeature 関数は、製品の機能 (feature) のインストール状態を構成します。(ANSI)

戻り値

意味
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。
ERROR_SUCCESS
関数は成功しました。
アクションに関連するエラー
詳細については、 Error Codes を参照してください。
初期化エラー
初期化に関連するエラーが発生しました。

解説(Remarks)

メモ

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

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

DWORD MsiConfigureFeatureA(
    LPCSTR szProduct,
    LPCSTR szFeature,
    INSTALLSTATE eInstallState
);
[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiConfigureFeatureA(
    [MarshalAs(UnmanagedType.LPStr)] string szProduct,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szFeature,   // LPCSTR
    int eInstallState   // INSTALLSTATE
);
<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiConfigureFeatureA(
    <MarshalAs(UnmanagedType.LPStr)> szProduct As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szFeature As String,   ' LPCSTR
    eInstallState As Integer   ' INSTALLSTATE
) As UInteger
End Function
' szProduct : LPCSTR
' szFeature : LPCSTR
' eInstallState : INSTALLSTATE
Declare PtrSafe Function MsiConfigureFeatureA Lib "msi" ( _
    ByVal szProduct As String, _
    ByVal szFeature As String, _
    ByVal eInstallState As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiConfigureFeatureA = ctypes.windll.msi.MsiConfigureFeatureA
MsiConfigureFeatureA.restype = wintypes.DWORD
MsiConfigureFeatureA.argtypes = [
    wintypes.LPCSTR,  # szProduct : LPCSTR
    wintypes.LPCSTR,  # szFeature : LPCSTR
    ctypes.c_int,  # eInstallState : INSTALLSTATE
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiConfigureFeatureA = Fiddle::Function.new(
  lib['MsiConfigureFeatureA'],
  [
    Fiddle::TYPE_VOIDP,  # szProduct : LPCSTR
    Fiddle::TYPE_VOIDP,  # szFeature : LPCSTR
    Fiddle::TYPE_INT,  # eInstallState : INSTALLSTATE
  ],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiConfigureFeatureA(
        szProduct: *const u8,  // LPCSTR
        szFeature: *const u8,  // LPCSTR
        eInstallState: i32  // INSTALLSTATE
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiConfigureFeatureA([MarshalAs(UnmanagedType.LPStr)] string szProduct, [MarshalAs(UnmanagedType.LPStr)] string szFeature, int eInstallState);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiConfigureFeatureA' -Namespace Win32 -PassThru
# $api::MsiConfigureFeatureA(szProduct, szFeature, eInstallState)
#uselib "msi.dll"
#func global MsiConfigureFeatureA "MsiConfigureFeatureA" sptr, sptr, sptr
; MsiConfigureFeatureA szProduct, szFeature, eInstallState   ; 戻り値は stat
; szProduct : LPCSTR -> "sptr"
; szFeature : LPCSTR -> "sptr"
; eInstallState : INSTALLSTATE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiConfigureFeatureA "MsiConfigureFeatureA" str, str, int
; res = MsiConfigureFeatureA(szProduct, szFeature, eInstallState)
; szProduct : LPCSTR -> "str"
; szFeature : LPCSTR -> "str"
; eInstallState : INSTALLSTATE -> "int"
; DWORD MsiConfigureFeatureA(LPCSTR szProduct, LPCSTR szFeature, INSTALLSTATE eInstallState)
#uselib "msi.dll"
#cfunc global MsiConfigureFeatureA "MsiConfigureFeatureA" str, str, int
; res = MsiConfigureFeatureA(szProduct, szFeature, eInstallState)
; szProduct : LPCSTR -> "str"
; szFeature : LPCSTR -> "str"
; eInstallState : INSTALLSTATE -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiConfigureFeatureA = msi.NewProc("MsiConfigureFeatureA")
)

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

extern "msi" fn MsiConfigureFeatureA(
    szProduct: [*c]const u8, // LPCSTR
    szFeature: [*c]const u8, // LPCSTR
    eInstallState: i32 // INSTALLSTATE
) callconv(std.os.windows.WINAPI) u32;
proc MsiConfigureFeatureA(
    szProduct: cstring,  # LPCSTR
    szFeature: cstring,  # LPCSTR
    eInstallState: int32  # INSTALLSTATE
): uint32 {.importc: "MsiConfigureFeatureA", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiConfigureFeatureA(
    const(char)* szProduct,   // LPCSTR
    const(char)* szFeature,   // LPCSTR
    int eInstallState   // INSTALLSTATE
);
ccall((:MsiConfigureFeatureA, "msi.dll"), stdcall, UInt32,
      (Cstring, Cstring, Int32),
      szProduct, szFeature, eInstallState)
# szProduct : LPCSTR -> Cstring
# szFeature : LPCSTR -> Cstring
# eInstallState : INSTALLSTATE -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiConfigureFeatureA(
    const char* szProduct,
    const char* szFeature,
    int32_t eInstallState);
]]
local msi = ffi.load("msi")
-- msi.MsiConfigureFeatureA(szProduct, szFeature, eInstallState)
-- szProduct : LPCSTR
-- szFeature : LPCSTR
-- eInstallState : INSTALLSTATE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiConfigureFeatureA = lib.func('__stdcall', 'MsiConfigureFeatureA', 'uint32_t', ['str', 'str', 'int32_t']);
// MsiConfigureFeatureA(szProduct, szFeature, eInstallState)
// szProduct : LPCSTR -> 'str'
// szFeature : LPCSTR -> 'str'
// eInstallState : INSTALLSTATE -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiConfigureFeatureA: { parameters: ["buffer", "buffer", "i32"], result: "u32" },
});
// lib.symbols.MsiConfigureFeatureA(szProduct, szFeature, eInstallState)
// szProduct : LPCSTR -> "buffer"
// szFeature : LPCSTR -> "buffer"
// eInstallState : INSTALLSTATE -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiConfigureFeatureA(
    const char* szProduct,
    const char* szFeature,
    int32_t eInstallState);
C, "msi.dll");
// $ffi->MsiConfigureFeatureA(szProduct, szFeature, eInstallState);
// szProduct : LPCSTR
// szFeature : LPCSTR
// eInstallState : 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 MsiConfigureFeatureA(
        String szProduct,   // LPCSTR
        String szFeature,   // LPCSTR
        int eInstallState   // INSTALLSTATE
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiConfigureFeatureA = MsiConfigureFeatureA(
    szProduct : UInt8*,   # LPCSTR
    szFeature : UInt8*,   # LPCSTR
    eInstallState : 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 MsiConfigureFeatureANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Int32);
typedef MsiConfigureFeatureADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int);
final MsiConfigureFeatureA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiConfigureFeatureANative, MsiConfigureFeatureADart>('MsiConfigureFeatureA');
// szProduct : LPCSTR -> Pointer<Utf8>
// szFeature : LPCSTR -> Pointer<Utf8>
// eInstallState : INSTALLSTATE -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiConfigureFeatureA(
  szProduct: PAnsiChar;   // LPCSTR
  szFeature: PAnsiChar;   // LPCSTR
  eInstallState: Integer   // INSTALLSTATE
): DWORD; stdcall;
  external 'msi.dll' name 'MsiConfigureFeatureA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiConfigureFeatureA"
  c_MsiConfigureFeatureA :: CString -> CString -> Int32 -> IO Word32
-- szProduct : LPCSTR -> CString
-- szFeature : LPCSTR -> CString
-- eInstallState : INSTALLSTATE -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msiconfigurefeaturea =
  foreign "MsiConfigureFeatureA"
    (string @-> string @-> int32_t @-> returning uint32_t)
(* szProduct : LPCSTR -> string *)
(* szFeature : LPCSTR -> string *)
(* eInstallState : 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 ("MsiConfigureFeatureA" msi-configure-feature-a :convention :stdcall) :uint32
  (sz-product :string)   ; LPCSTR
  (sz-feature :string)   ; LPCSTR
  (e-install-state :int32))   ; INSTALLSTATE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiConfigureFeatureA = Win32::API::More->new('msi',
    'DWORD MsiConfigureFeatureA(LPCSTR szProduct, LPCSTR szFeature, int eInstallState)');
# my $ret = $MsiConfigureFeatureA->Call($szProduct, $szFeature, $eInstallState);
# szProduct : LPCSTR -> LPCSTR
# szFeature : LPCSTR -> LPCSTR
# eInstallState : INSTALLSTATE -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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