ホーム › System.ApplicationInstallationAndServicing › MsiGetFileVersionW

MsiGetFileVersionW

関数

指定ファイルのバージョンと言語の情報を取得する。

DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiGetFileVersionW(
    LPCWSTR szFilePath,
    LPWSTR lpVersionBuf,   // optional
    DWORD* pcchVersionBuf,   // optional
    LPWSTR lpLangBuf,   // optional
    DWORD* pcchLangBuf   // optional
);

パラメーター

名前	型	方向	説明
szFilePath	LPCWSTR	in	ファイルへのパスを指定します。
lpVersionBuf	LPWSTR	outoptional	ファイルのバージョンを返します。言語情報のみを取得する場合は 0 を設定します。
pcchVersionBuf	DWORD*	inoutoptional	入出力バッファのサイズ。TCHAR の数で指定します。言語情報のみを取得する場合は 0(ゼロ)を設定します。入力時には、終端の null 文字分の領域を含むバッファの全体サイズを指定します。渡されたバッファが小さすぎる場合、返されるカウントには終端の null 文字は含まれません。
lpLangBuf	LPWSTR	outoptional	ファイルの言語を返します。バージョン情報のみを取得する場合は 0(ゼロ)を設定します。
pcchLangBuf	DWORD*	inoutoptional	入出力バッファのサイズ。TCHAR の数で指定します。バージョン情報のみを取得する場合は 0(ゼロ)を設定します。入力時には、終端の null 文字分の領域を含むバッファの全体サイズを指定します。渡されたバッファが小さすぎる場合、返されるカウントには終端の null 文字は含まれません。

戻り値の型: DWORD

公式ドキュメント

MsiGetFileVersion は、インストーラーがデータベース内で見つけることを想定している形式で、バージョン文字列と言語文字列を返します。(Unicode)

戻り値

値	意味
ERROR_SUCCESS	正常に完了しました。
ERROR_FILE_NOT_FOUND	ファイルが存在しません。
ERROR_ACCESS_DENIED	バージョン情報を取得するためにファイルを開くことができません。
ERROR_FILE_INVALID	ファイルにバージョン情報が含まれていません。
ERROR_INVALID_DATA	バージョン情報が無効です。
E_FAIL	予期しないエラーが発生しました。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiGetFileVersionW(
    LPCWSTR szFilePath,
    LPWSTR lpVersionBuf,   // optional
    DWORD* pcchVersionBuf,   // optional
    LPWSTR lpLangBuf,   // optional
    DWORD* pcchLangBuf   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiGetFileVersionW(
    [MarshalAs(UnmanagedType.LPWStr)] string szFilePath,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpVersionBuf,   // LPWSTR optional, out
    IntPtr pcchVersionBuf,   // DWORD* optional, in/out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpLangBuf,   // LPWSTR optional, out
    IntPtr pcchLangBuf   // DWORD* optional, in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiGetFileVersionW(
    <MarshalAs(UnmanagedType.LPWStr)> szFilePath As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpVersionBuf As System.Text.StringBuilder,   ' LPWSTR optional, out
    pcchVersionBuf As IntPtr,   ' DWORD* optional, in/out
    <MarshalAs(UnmanagedType.LPWStr)> lpLangBuf As System.Text.StringBuilder,   ' LPWSTR optional, out
    pcchLangBuf As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' szFilePath : LPCWSTR
' lpVersionBuf : LPWSTR optional, out
' pcchVersionBuf : DWORD* optional, in/out
' lpLangBuf : LPWSTR optional, out
' pcchLangBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiGetFileVersionW Lib "msi" ( _
    ByVal szFilePath As LongPtr, _
    ByVal lpVersionBuf As LongPtr, _
    ByVal pcchVersionBuf As LongPtr, _
    ByVal lpLangBuf As LongPtr, _
    ByVal pcchLangBuf As LongPtr) 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

MsiGetFileVersionW = ctypes.windll.msi.MsiGetFileVersionW
MsiGetFileVersionW.restype = wintypes.DWORD
MsiGetFileVersionW.argtypes = [
    wintypes.LPCWSTR,  # szFilePath : LPCWSTR
    wintypes.LPWSTR,  # lpVersionBuf : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchVersionBuf : DWORD* optional, in/out
    wintypes.LPWSTR,  # lpLangBuf : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchLangBuf : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiGetFileVersionW = Fiddle::Function.new(
  lib['MsiGetFileVersionW'],
  [
    Fiddle::TYPE_VOIDP,  # szFilePath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpVersionBuf : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchVersionBuf : DWORD* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpLangBuf : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchLangBuf : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "msi")]
extern "system" {
    fn MsiGetFileVersionW(
        szFilePath: *const u16,  // LPCWSTR
        lpVersionBuf: *mut u16,  // LPWSTR optional, out
        pcchVersionBuf: *mut u32,  // DWORD* optional, in/out
        lpLangBuf: *mut u16,  // LPWSTR optional, out
        pcchLangBuf: *mut u32  // DWORD* optional, in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiGetFileVersionW([MarshalAs(UnmanagedType.LPWStr)] string szFilePath, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpVersionBuf, IntPtr pcchVersionBuf, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpLangBuf, IntPtr pcchLangBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetFileVersionW' -Namespace Win32 -PassThru
# $api::MsiGetFileVersionW(szFilePath, lpVersionBuf, pcchVersionBuf, lpLangBuf, pcchLangBuf)

#uselib "msi.dll"
#func global MsiGetFileVersionW "MsiGetFileVersionW" wptr, wptr, wptr, wptr, wptr
; MsiGetFileVersionW szFilePath, varptr(lpVersionBuf), varptr(pcchVersionBuf), varptr(lpLangBuf), varptr(pcchLangBuf)   ; 戻り値は stat
; szFilePath : LPCWSTR -> "wptr"
; lpVersionBuf : LPWSTR optional, out -> "wptr"
; pcchVersionBuf : DWORD* optional, in/out -> "wptr"
; lpLangBuf : LPWSTR optional, out -> "wptr"
; pcchLangBuf : DWORD* optional, in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msi.dll"
#cfunc global MsiGetFileVersionW "MsiGetFileVersionW" wstr, var, var, var, var
; res = MsiGetFileVersionW(szFilePath, lpVersionBuf, pcchVersionBuf, lpLangBuf, pcchLangBuf)
; szFilePath : LPCWSTR -> "wstr"
; lpVersionBuf : LPWSTR optional, out -> "var"
; pcchVersionBuf : DWORD* optional, in/out -> "var"
; lpLangBuf : LPWSTR optional, out -> "var"
; pcchLangBuf : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiGetFileVersionW "MsiGetFileVersionW" wstr, sptr, sptr, sptr, sptr
; res = MsiGetFileVersionW(szFilePath, varptr(lpVersionBuf), varptr(pcchVersionBuf), varptr(lpLangBuf), varptr(pcchLangBuf))
; szFilePath : LPCWSTR -> "wstr"
; lpVersionBuf : LPWSTR optional, out -> "sptr"
; pcchVersionBuf : DWORD* optional, in/out -> "sptr"
; lpLangBuf : LPWSTR optional, out -> "sptr"
; pcchLangBuf : DWORD* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。