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

MsiGetFeatureUsageA

関数
機能の使用回数と最終使用日を取得する(ANSI版)。
DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiGetFeatureUsageA(
    LPCSTR szProduct,
    LPCSTR szFeature,
    DWORD* pdwUseCount,   // optional
    WORD* pwDateUsed   // optional
);

パラメーター

名前方向説明
szProductLPCSTRin機能を含む製品の製品コードを指定します。
szFeatureLPCSTRinメトリックを返す対象となる機能の機能コードを指定します。
pdwUseCountDWORD*outoptionalその機能が使用された回数を示します。
pwDateUsedWORD*outoptional

機能が最後に使用された日付を指定します。日付は次の表に示す MS-DOS 日付形式です。

ビット 意味
0 – 4
日 (1~31)
5 – 8
月 (1 = 1月、2 = 2月、以下同様)
9 – 15
1980 年からの年オフセット (実際の年を得るには 1980 を加算)

戻り値の型: DWORD

公式ドキュメント

MsiGetFeatureUsage 関数は、製品機能の使用状況メトリックを返します。(ANSI)

戻り値

MsiGetFeatureUsage 関数は次の値を返します。

意味
ERROR_BAD_CONFIGURATION
構成データが破損しています。
ERROR_INSTALL_FAILURE
使用状況情報が利用できないか、製品または機能が無効です。
ERROR_SUCCESS
関数が正常に完了しました。

解説(Remarks)

メモ

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

MsiGetFeatureUsageA = ctypes.windll.msi.MsiGetFeatureUsageA
MsiGetFeatureUsageA.restype = wintypes.DWORD
MsiGetFeatureUsageA.argtypes = [
    wintypes.LPCSTR,  # szProduct : LPCSTR
    wintypes.LPCSTR,  # szFeature : LPCSTR
    ctypes.POINTER(wintypes.DWORD),  # pdwUseCount : DWORD* optional, out
    ctypes.POINTER(ctypes.c_ushort),  # pwDateUsed : WORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiGetFeatureUsageA = Fiddle::Function.new(
  lib['MsiGetFeatureUsageA'],
  [
    Fiddle::TYPE_VOIDP,  # szProduct : LPCSTR
    Fiddle::TYPE_VOIDP,  # szFeature : LPCSTR
    Fiddle::TYPE_VOIDP,  # pdwUseCount : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pwDateUsed : WORD* optional, out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiGetFeatureUsageA(
        szProduct: *const u8,  // LPCSTR
        szFeature: *const u8,  // LPCSTR
        pdwUseCount: *mut u32,  // DWORD* optional, out
        pwDateUsed: *mut u16  // WORD* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiGetFeatureUsageA([MarshalAs(UnmanagedType.LPStr)] string szProduct, [MarshalAs(UnmanagedType.LPStr)] string szFeature, IntPtr pdwUseCount, IntPtr pwDateUsed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetFeatureUsageA' -Namespace Win32 -PassThru
# $api::MsiGetFeatureUsageA(szProduct, szFeature, pdwUseCount, pwDateUsed)
#uselib "msi.dll"
#func global MsiGetFeatureUsageA "MsiGetFeatureUsageA" sptr, sptr, sptr, sptr
; MsiGetFeatureUsageA szProduct, szFeature, varptr(pdwUseCount), varptr(pwDateUsed)   ; 戻り値は stat
; szProduct : LPCSTR -> "sptr"
; szFeature : LPCSTR -> "sptr"
; pdwUseCount : DWORD* optional, out -> "sptr"
; pwDateUsed : WORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "msi.dll"
#cfunc global MsiGetFeatureUsageA "MsiGetFeatureUsageA" str, str, var, var
; res = MsiGetFeatureUsageA(szProduct, szFeature, pdwUseCount, pwDateUsed)
; szProduct : LPCSTR -> "str"
; szFeature : LPCSTR -> "str"
; pdwUseCount : DWORD* optional, out -> "var"
; pwDateUsed : WORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD MsiGetFeatureUsageA(LPCSTR szProduct, LPCSTR szFeature, DWORD* pdwUseCount, WORD* pwDateUsed)
#uselib "msi.dll"
#cfunc global MsiGetFeatureUsageA "MsiGetFeatureUsageA" str, str, var, var
; res = MsiGetFeatureUsageA(szProduct, szFeature, pdwUseCount, pwDateUsed)
; szProduct : LPCSTR -> "str"
; szFeature : LPCSTR -> "str"
; pdwUseCount : DWORD* optional, out -> "var"
; pwDateUsed : WORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiGetFeatureUsageA = msi.NewProc("MsiGetFeatureUsageA")
)

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

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

typedef MsiGetFeatureUsageANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>, Pointer<Uint16>);
typedef MsiGetFeatureUsageADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>, Pointer<Uint16>);
final MsiGetFeatureUsageA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiGetFeatureUsageANative, MsiGetFeatureUsageADart>('MsiGetFeatureUsageA');
// szProduct : LPCSTR -> Pointer<Utf8>
// szFeature : LPCSTR -> Pointer<Utf8>
// pdwUseCount : DWORD* optional, out -> Pointer<Uint32>
// pwDateUsed : WORD* optional, out -> Pointer<Uint16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiGetFeatureUsageA(
  szProduct: PAnsiChar;   // LPCSTR
  szFeature: PAnsiChar;   // LPCSTR
  pdwUseCount: Pointer;   // DWORD* optional, out
  pwDateUsed: Pointer   // WORD* optional, out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiGetFeatureUsageA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiGetFeatureUsageA"
  c_MsiGetFeatureUsageA :: CString -> CString -> Ptr Word32 -> Ptr Word16 -> IO Word32
-- szProduct : LPCSTR -> CString
-- szFeature : LPCSTR -> CString
-- pdwUseCount : DWORD* optional, out -> Ptr Word32
-- pwDateUsed : WORD* optional, out -> Ptr Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msigetfeatureusagea =
  foreign "MsiGetFeatureUsageA"
    (string @-> string @-> (ptr uint32_t) @-> (ptr uint16_t) @-> returning uint32_t)
(* szProduct : LPCSTR -> string *)
(* szFeature : LPCSTR -> string *)
(* pdwUseCount : DWORD* optional, out -> (ptr uint32_t) *)
(* pwDateUsed : WORD* optional, out -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiGetFeatureUsageA" msi-get-feature-usage-a :convention :stdcall) :uint32
  (sz-product :string)   ; LPCSTR
  (sz-feature :string)   ; LPCSTR
  (pdw-use-count :pointer)   ; DWORD* optional, out
  (pw-date-used :pointer))   ; WORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiGetFeatureUsageA = Win32::API::More->new('msi',
    'DWORD MsiGetFeatureUsageA(LPCSTR szProduct, LPCSTR szFeature, LPVOID pdwUseCount, LPVOID pwDateUsed)');
# my $ret = $MsiGetFeatureUsageA->Call($szProduct, $szFeature, $pdwUseCount, $pwDateUsed);
# szProduct : LPCSTR -> LPCSTR
# szFeature : LPCSTR -> LPCSTR
# pdwUseCount : DWORD* optional, out -> LPVOID
# pwDateUsed : WORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い