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

MsiUseFeatureExA

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

シグネチャ

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

INSTALLSTATE MsiUseFeatureExA(
    LPCSTR szProduct,
    LPCSTR szFeature,
    DWORD dwInstallMode,
    DWORD dwReserved   // optional
);

パラメーター

名前方向説明
szProductLPCSTRin使用する機能を所有する製品のプロダクト コードを指定します。
szFeatureLPCSTRin使用する機能を識別します。
dwInstallModeDWORDin

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

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

戻り値の型: INSTALLSTATE

公式ドキュメント

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

戻り値

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

解説(Remarks)

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

メモ

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

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

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

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiUseFeatureExA = msi.NewProc("MsiUseFeatureExA")
)

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

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

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

let msiusefeatureexa =
  foreign "MsiUseFeatureExA"
    (string @-> string @-> uint32_t @-> uint32_t @-> returning int32_t)
(* szProduct : LPCSTR -> string *)
(* szFeature : LPCSTR -> string *)
(* 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 ("MsiUseFeatureExA" msi-use-feature-ex-a :convention :stdcall) :int32
  (sz-product :string)   ; LPCSTR
  (sz-feature :string)   ; LPCSTR
  (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 $MsiUseFeatureExA = Win32::API::More->new('msi',
    'int MsiUseFeatureExA(LPCSTR szProduct, LPCSTR szFeature, DWORD dwInstallMode, DWORD dwReserved)');
# my $ret = $MsiUseFeatureExA->Call($szProduct, $szFeature, $dwInstallMode, $dwReserved);
# szProduct : LPCSTR -> LPCSTR
# szFeature : LPCSTR -> LPCSTR
# dwInstallMode : DWORD -> DWORD
# dwReserved : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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