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

MsiUseFeatureA

関数
機能の使用を記録し利用可能か返す(ANSI版)。
DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

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

INSTALLSTATE MsiUseFeatureA(
    LPCSTR szProduct,
    LPCSTR szFeature
);

パラメーター

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

戻り値の型: INSTALLSTATE

公式ドキュメント

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

戻り値

意味
INSTALLSTATE_ABSENT
機能がインストールされていません。
INSTALLSTATE_ADVERTISED
機能はアドバタイズされています。
INSTALLSTATE_BADCONFIG
構成データが破損しています。
INSTALLSTATE_INVALIDARG
関数の引数が無効です。
INSTALLSTATE_LOCAL
機能はローカルにインストールされており、使用可能です。
INSTALLSTATE_SOURCE
機能はソースからインストールされており、使用可能です。
INSTALLSTATE_UNKNOWN
機能は公開されていません。

解説(Remarks)

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

メモ

msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiUseFeature を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不整合が発生する可能性があります。詳細については、「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 MsiUseFeatureA(
    LPCSTR szProduct,
    LPCSTR szFeature
);
[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int MsiUseFeatureA(
    [MarshalAs(UnmanagedType.LPStr)] string szProduct,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szFeature   // LPCSTR
);
<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiUseFeatureA(
    <MarshalAs(UnmanagedType.LPStr)> szProduct As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szFeature As String   ' LPCSTR
) As Integer
End Function
' szProduct : LPCSTR
' szFeature : LPCSTR
Declare PtrSafe Function MsiUseFeatureA Lib "msi" ( _
    ByVal szProduct As String, _
    ByVal szFeature As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiUseFeatureA = msi.NewProc("MsiUseFeatureA")
)

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

extern "msi" fn MsiUseFeatureA(
    szProduct: [*c]const u8, // LPCSTR
    szFeature: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;
proc MsiUseFeatureA(
    szProduct: cstring,  # LPCSTR
    szFeature: cstring  # LPCSTR
): int32 {.importc: "MsiUseFeatureA", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
int MsiUseFeatureA(
    const(char)* szProduct,   // LPCSTR
    const(char)* szFeature   // LPCSTR
);
ccall((:MsiUseFeatureA, "msi.dll"), stdcall, Int32,
      (Cstring, Cstring),
      szProduct, szFeature)
# szProduct : LPCSTR -> Cstring
# szFeature : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t MsiUseFeatureA(
    const char* szProduct,
    const char* szFeature);
]]
local msi = ffi.load("msi")
-- msi.MsiUseFeatureA(szProduct, szFeature)
-- szProduct : LPCSTR
-- szFeature : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiUseFeatureA = lib.func('__stdcall', 'MsiUseFeatureA', 'int32_t', ['str', 'str']);
// MsiUseFeatureA(szProduct, szFeature)
// szProduct : LPCSTR -> 'str'
// szFeature : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiUseFeatureA: { parameters: ["buffer", "buffer"], result: "i32" },
});
// lib.symbols.MsiUseFeatureA(szProduct, szFeature)
// szProduct : LPCSTR -> "buffer"
// szFeature : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t MsiUseFeatureA(
    const char* szProduct,
    const char* szFeature);
C, "msi.dll");
// $ffi->MsiUseFeatureA(szProduct, szFeature);
// szProduct : LPCSTR
// szFeature : LPCSTR
// 構造体/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 MsiUseFeatureA(
        String szProduct,   // LPCSTR
        String szFeature   // LPCSTR
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiUseFeatureA = MsiUseFeatureA(
    szProduct : UInt8*,   # LPCSTR
    szFeature : UInt8*   # LPCSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiUseFeatureANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>);
typedef MsiUseFeatureADart = int Function(Pointer<Utf8>, Pointer<Utf8>);
final MsiUseFeatureA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiUseFeatureANative, MsiUseFeatureADart>('MsiUseFeatureA');
// szProduct : LPCSTR -> Pointer<Utf8>
// szFeature : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiUseFeatureA(
  szProduct: PAnsiChar;   // LPCSTR
  szFeature: PAnsiChar   // LPCSTR
): Integer; stdcall;
  external 'msi.dll' name 'MsiUseFeatureA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let msiusefeaturea =
  foreign "MsiUseFeatureA"
    (string @-> string @-> returning int32_t)
(* szProduct : LPCSTR -> string *)
(* szFeature : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiUseFeatureA" msi-use-feature-a :convention :stdcall) :int32
  (sz-product :string)   ; LPCSTR
  (sz-feature :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiUseFeatureA = Win32::API::More->new('msi',
    'int MsiUseFeatureA(LPCSTR szProduct, LPCSTR szFeature)');
# my $ret = $MsiUseFeatureA->Call($szProduct, $szFeature);
# szProduct : LPCSTR -> LPCSTR
# szFeature : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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