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

MsiSetFeatureAttributesW

関数
機能のインストール属性を設定する(Unicode版)。
DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiSetFeatureAttributesW(
    MSIHANDLE hInstall,
    LPCWSTR szFeature,
    DWORD dwAttributes
);

パラメーター

名前方向説明
hInstallMSIHANDLEinDLL カスタムアクションに提供されるインストールへのハンドル、または MsiOpenPackageMsiOpenPackageExMsiOpenProduct を通じて取得したハンドルです。
szFeatureLPCWSTRin製品内の機能名を指定します。
dwAttributesDWORDin

実行時に一連のビットフラグとして指定する機能の属性です。

定数 意味
INSTALLFEATUREATTRIBUTE_FAVORLOCAL
1
実行時に機能の既定の属性を msidbFeatureAttributesFavorLocal に変更します。説明については Feature テーブルの Attributes 列を参照してください。
INSTALLFEATUREATTRIBUTE_FAVORSOURCE
2
実行時に機能の既定の属性を msidbFeatureAttributesFavorSource に変更します。説明については Feature テーブルの Attributes 列を参照してください。
INSTALLFEATUREATTRIBUTE_FOLLOWPARENT
4
実行時に機能の既定の属性を msidbFeatureAttributesFollowParent に変更します。これはトップレベルの機能に設定できる有効な属性ではない点に注意してください。説明については Feature テーブルの Attributes 列を参照してください。
INSTALLFEATUREATTRIBUTE_FAVORADVERTISE
8
実行時に機能の既定の属性を msidbFeatureAttributesFavorAdvertise に変更します。説明については Feature テーブルの Attributes 列を参照してください。
INSTALLFEATUREATTRIBUTE_DISALLOWADVERTISE
16
実行時に機能の既定の属性を msidbFeatureAttributesDisallowAdvertise に変更します。説明については Feature テーブルの Attributes 列を参照してください。
INSTALLFEATUREATTRIBUTE_NOUNSUPPORTEDADVERTISE
32
実行時に機能の既定の属性を msidbFeatureAttributesNoUnsupportedAdvertise に変更します。説明については Feature テーブルの Attributes 列を参照してください。

戻り値の型: DWORD

公式ドキュメント

MsiSetFeatureAttributes 関数は、実行時に機能 (feature) の既定の属性を変更できます。機能の既定の属性は、Feature テーブルの Attributes 列で定義されている点に注意してください。(Unicode)

戻り値

この関数は UINT を返します。

解説(Remarks)

MsiSetFeatureAttributesCostInitialize アクションの後、かつ CostFinalize アクションの前に呼び出す必要があります。それ以外のタイミングで呼び出された場合、この関数は ERROR_FUNCTION_FAILED を返します。

INSTALLFEATUREATTRIBUTE_FAVORLOCALINSTALLFEATUREATTRIBUTE_FAVORSOURCEINSTALLFEATUREATTRIBUTE_FOLLOWPARENT の各フラグは相互に排他的です。いずれかの機能に対して設定できるのは、これらのビットのうち 1 つだけです。これらのフラグが複数設定された場合、その機能の動作は未定義となります。

Calling Database Functions From Programs を参照してください。

メモ

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

DWORD MsiSetFeatureAttributesW(
    MSIHANDLE hInstall,
    LPCWSTR szFeature,
    DWORD dwAttributes
);
[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiSetFeatureAttributesW(
    uint hInstall,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string szFeature,   // LPCWSTR
    uint dwAttributes   // DWORD
);
<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiSetFeatureAttributesW(
    hInstall As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPWStr)> szFeature As String,   ' LPCWSTR
    dwAttributes As UInteger   ' DWORD
) As UInteger
End Function
' hInstall : MSIHANDLE
' szFeature : LPCWSTR
' dwAttributes : DWORD
Declare PtrSafe Function MsiSetFeatureAttributesW Lib "msi" ( _
    ByVal hInstall As Long, _
    ByVal szFeature As LongPtr, _
    ByVal dwAttributes 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

MsiSetFeatureAttributesW = ctypes.windll.msi.MsiSetFeatureAttributesW
MsiSetFeatureAttributesW.restype = wintypes.DWORD
MsiSetFeatureAttributesW.argtypes = [
    wintypes.DWORD,  # hInstall : MSIHANDLE
    wintypes.LPCWSTR,  # szFeature : LPCWSTR
    wintypes.DWORD,  # dwAttributes : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiSetFeatureAttributesW = Fiddle::Function.new(
  lib['MsiSetFeatureAttributesW'],
  [
    -Fiddle::TYPE_INT,  # hInstall : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szFeature : LPCWSTR
    -Fiddle::TYPE_INT,  # dwAttributes : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "msi")]
extern "system" {
    fn MsiSetFeatureAttributesW(
        hInstall: u32,  // MSIHANDLE
        szFeature: *const u16,  // LPCWSTR
        dwAttributes: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiSetFeatureAttributesW(uint hInstall, [MarshalAs(UnmanagedType.LPWStr)] string szFeature, uint dwAttributes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiSetFeatureAttributesW' -Namespace Win32 -PassThru
# $api::MsiSetFeatureAttributesW(hInstall, szFeature, dwAttributes)
#uselib "msi.dll"
#func global MsiSetFeatureAttributesW "MsiSetFeatureAttributesW" wptr, wptr, wptr
; MsiSetFeatureAttributesW hInstall, szFeature, dwAttributes   ; 戻り値は stat
; hInstall : MSIHANDLE -> "wptr"
; szFeature : LPCWSTR -> "wptr"
; dwAttributes : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiSetFeatureAttributesW "MsiSetFeatureAttributesW" int, wstr, int
; res = MsiSetFeatureAttributesW(hInstall, szFeature, dwAttributes)
; hInstall : MSIHANDLE -> "int"
; szFeature : LPCWSTR -> "wstr"
; dwAttributes : DWORD -> "int"
; DWORD MsiSetFeatureAttributesW(MSIHANDLE hInstall, LPCWSTR szFeature, DWORD dwAttributes)
#uselib "msi.dll"
#cfunc global MsiSetFeatureAttributesW "MsiSetFeatureAttributesW" int, wstr, int
; res = MsiSetFeatureAttributesW(hInstall, szFeature, dwAttributes)
; hInstall : MSIHANDLE -> "int"
; szFeature : LPCWSTR -> "wstr"
; dwAttributes : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiSetFeatureAttributesW = msi.NewProc("MsiSetFeatureAttributesW")
)

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

extern "msi" fn MsiSetFeatureAttributesW(
    hInstall: u32, // MSIHANDLE
    szFeature: [*c]const u16, // LPCWSTR
    dwAttributes: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc MsiSetFeatureAttributesW(
    hInstall: uint32,  # MSIHANDLE
    szFeature: WideCString,  # LPCWSTR
    dwAttributes: uint32  # DWORD
): uint32 {.importc: "MsiSetFeatureAttributesW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "msi");
extern(Windows)
uint MsiSetFeatureAttributesW(
    uint hInstall,   // MSIHANDLE
    const(wchar)* szFeature,   // LPCWSTR
    uint dwAttributes   // DWORD
);
ccall((:MsiSetFeatureAttributesW, "msi.dll"), stdcall, UInt32,
      (UInt32, Cwstring, UInt32),
      hInstall, szFeature, dwAttributes)
# hInstall : MSIHANDLE -> UInt32
# szFeature : LPCWSTR -> Cwstring
# dwAttributes : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiSetFeatureAttributesW(
    uint32_t hInstall,
    const uint16_t* szFeature,
    uint32_t dwAttributes);
]]
local msi = ffi.load("msi")
-- msi.MsiSetFeatureAttributesW(hInstall, szFeature, dwAttributes)
-- hInstall : MSIHANDLE
-- szFeature : LPCWSTR
-- dwAttributes : DWORD
-- 構造体/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 MsiSetFeatureAttributesW = lib.func('__stdcall', 'MsiSetFeatureAttributesW', 'uint32_t', ['uint32_t', 'str16', 'uint32_t']);
// MsiSetFeatureAttributesW(hInstall, szFeature, dwAttributes)
// hInstall : MSIHANDLE -> 'uint32_t'
// szFeature : LPCWSTR -> 'str16'
// dwAttributes : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiSetFeatureAttributesW: { parameters: ["u32", "buffer", "u32"], result: "u32" },
});
// lib.symbols.MsiSetFeatureAttributesW(hInstall, szFeature, dwAttributes)
// hInstall : MSIHANDLE -> "u32"
// szFeature : LPCWSTR -> "buffer"
// dwAttributes : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiSetFeatureAttributesW(
    uint32_t hInstall,
    const uint16_t* szFeature,
    uint32_t dwAttributes);
C, "msi.dll");
// $ffi->MsiSetFeatureAttributesW(hInstall, szFeature, dwAttributes);
// hInstall : MSIHANDLE
// szFeature : LPCWSTR
// dwAttributes : DWORD
// 構造体/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 MsiSetFeatureAttributesW(
        int hInstall,   // MSIHANDLE
        WString szFeature,   // LPCWSTR
        int dwAttributes   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("msi")]
lib Libmsi
  fun MsiSetFeatureAttributesW = MsiSetFeatureAttributesW(
    hInstall : UInt32,   # MSIHANDLE
    szFeature : UInt16*,   # LPCWSTR
    dwAttributes : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiSetFeatureAttributesWNative = Uint32 Function(Uint32, Pointer<Utf16>, Uint32);
typedef MsiSetFeatureAttributesWDart = int Function(int, Pointer<Utf16>, int);
final MsiSetFeatureAttributesW = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiSetFeatureAttributesWNative, MsiSetFeatureAttributesWDart>('MsiSetFeatureAttributesW');
// hInstall : MSIHANDLE -> Uint32
// szFeature : LPCWSTR -> Pointer<Utf16>
// dwAttributes : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiSetFeatureAttributesW(
  hInstall: DWORD;   // MSIHANDLE
  szFeature: PWideChar;   // LPCWSTR
  dwAttributes: DWORD   // DWORD
): DWORD; stdcall;
  external 'msi.dll' name 'MsiSetFeatureAttributesW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiSetFeatureAttributesW"
  c_MsiSetFeatureAttributesW :: Word32 -> CWString -> Word32 -> IO Word32
-- hInstall : MSIHANDLE -> Word32
-- szFeature : LPCWSTR -> CWString
-- dwAttributes : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msisetfeatureattributesw =
  foreign "MsiSetFeatureAttributesW"
    (uint32_t @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* hInstall : MSIHANDLE -> uint32_t *)
(* szFeature : LPCWSTR -> (ptr uint16_t) *)
(* dwAttributes : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiSetFeatureAttributesW" msi-set-feature-attributes-w :convention :stdcall) :uint32
  (h-install :uint32)   ; MSIHANDLE
  (sz-feature (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-attributes :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiSetFeatureAttributesW = Win32::API::More->new('msi',
    'DWORD MsiSetFeatureAttributesW(DWORD hInstall, LPCWSTR szFeature, DWORD dwAttributes)');
# my $ret = $MsiSetFeatureAttributesW->Call($hInstall, $szFeature, $dwAttributes);
# hInstall : MSIHANDLE -> DWORD
# szFeature : LPCWSTR -> LPCWSTR
# dwAttributes : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い