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

MsiUseFeatureExW

関数
モード指定で機能の使用を記録し状態を返す(Unicode版)。
DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

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

INSTALLSTATE MsiUseFeatureExW(
    LPCWSTR szProduct,
    LPCWSTR szFeature,
    DWORD dwInstallMode,
    DWORD dwReserved   // optional
);

パラメーター

名前方向説明
szProductLPCWSTRin使用する機能を所有する製品の製品コードを指定します。
szFeatureLPCWSTRin使用する機能を識別します。
dwInstallModeDWORDin

このパラメーターには次の値を指定できます。

意味
INSTALLMODE_NODETECTION
戻り値はインストール状態を示します。
dwReservedDWORDoptional将来の使用のために予約されています。この値は 0 に設定する必要があります。

戻り値の型: INSTALLSTATE

公式ドキュメント

MsiUseFeatureEx 関数は、特定の機能の使用回数をインクリメントし、その機能のインストール状態を示します。この関数は、アプリケーションが機能を使用する意図を示すために使用します。(Unicode)

戻り値

意味
INSTALLSTATE_ABSENT
機能はインストールされていません。
INSTALLSTATE_ADVERTISED
機能はアドバタイズされています。
INSTALLSTATE_LOCAL
機能はローカルにインストールされており、使用可能です。
INSTALLSTATE_SOURCE
機能はソースからインストールされており、使用可能です。
INSTALLSTATE_UNKNOWN
機能は公開されていません。

解説(Remarks)

MsiUseFeatureEx 関数は、公開されていることがわかっている機能に対してのみ使用してください。INSTALLSTATE_UNKNOWN は、プログラムが公開されていない機能を使用しようとしていることを示します。アプリケーションは、 MsiUseFeature を呼び出す前に、 MsiQueryFeatureState または MsiEnumFeatures を呼び出して、機能が公開されているかどうかを判断する必要があります。アプリケーションは、初期化中にこれらの呼び出しを行う必要があります。アプリケーションは、公開されていることがわかっている機能のみを使用してください。

メモ

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

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

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

MsiUseFeatureExW = ctypes.windll.msi.MsiUseFeatureExW
MsiUseFeatureExW.restype = ctypes.c_int
MsiUseFeatureExW.argtypes = [
    wintypes.LPCWSTR,  # szProduct : LPCWSTR
    wintypes.LPCWSTR,  # szFeature : LPCWSTR
    wintypes.DWORD,  # dwInstallMode : DWORD
    wintypes.DWORD,  # dwReserved : DWORD optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiUseFeatureExW = msi.NewProc("MsiUseFeatureExW")
)

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

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

typedef MsiUseFeatureExWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32, Uint32);
typedef MsiUseFeatureExWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int, int);
final MsiUseFeatureExW = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiUseFeatureExWNative, MsiUseFeatureExWDart>('MsiUseFeatureExW');
// szProduct : LPCWSTR -> Pointer<Utf16>
// szFeature : LPCWSTR -> Pointer<Utf16>
// dwInstallMode : DWORD -> Uint32
// dwReserved : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiUseFeatureExW(
  szProduct: PWideChar;   // LPCWSTR
  szFeature: PWideChar;   // LPCWSTR
  dwInstallMode: DWORD;   // DWORD
  dwReserved: DWORD   // DWORD optional
): Integer; stdcall;
  external 'msi.dll' name 'MsiUseFeatureExW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiUseFeatureExW"
  c_MsiUseFeatureExW :: CWString -> CWString -> Word32 -> Word32 -> IO Int32
-- szProduct : LPCWSTR -> CWString
-- szFeature : LPCWSTR -> CWString
-- dwInstallMode : DWORD -> Word32
-- dwReserved : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

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

関連項目

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