ホーム › Storage.FileSystem › GetFileVersionInfoSizeExW

GetFileVersionInfoSizeExW

関数

フラグ指定でバージョン情報の必要サイズを取得する。

DLLVERSION.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

DWORD GetFileVersionInfoSizeExW(
    GET_FILE_VERSION_INFO_FLAGS dwFlags,
    LPCWSTR lpwstrFilename,
    DWORD* lpdwHandle
);

パラメーター

名前

型

方向

説明

dwFlags

GET_FILE_VERSION_INFO_FLAGS

どの MUI DLL からバージョンリソースを抽出するか(抽出する場合)を制御します。次のフラグのうち 0 個以上を指定します。

値	意味
FILE_VER_GET_LOCALISED 0x01	対応する MUI ファイルが利用可能な場合、バージョンリソース全体(文字列とバイナリのバージョン情報の両方)を読み込みます。
FILE_VER_GET_NEUTRAL 0x002	対応する MUI ファイルが利用可能な場合はそこからバージョンリソース文字列を読み込み、対応する言語ニュートラルファイルが利用可能な場合はそこからバイナリのバージョン情報(VS_FIXEDFILEINFO)を読み込みます。

lpwstrFilename

LPCWSTR

対象となるファイルの名前です。この関数は LoadLibrary 関数が指定する検索順序を使用します。

lpdwHandle

DWORD*

out

この関数から戻るとき、ゼロに設定される変数へのポインターを含みます。この関数がゼロに設定するためです。このパラメーターは歴史的な理由で存在します。

戻り値の型: DWORD

公式ドキュメント

オペレーティングシステムが指定したファイルのバージョン情報を取得できるかどうかを判定します。バージョン情報が利用可能な場合、GetFileVersionInfoSizeEx はその情報のサイズをバイト単位で返します。(Unicode)

戻り値

型: DWORD

関数が成功した場合、戻り値はファイルのバージョン情報のサイズ(バイト単位)です。

関数が失敗した場合、戻り値はゼロです。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

GetFileVersionInfoEx 関数を呼び出す前に GetFileVersionInfoSizeEx 関数を呼び出してください。GetFileVersionInfoSizeEx が返すサイズは、GetFileVersionInfoEx が返すバージョン情報に必要なバッファーサイズを示します。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD GetFileVersionInfoSizeExW(
    GET_FILE_VERSION_INFO_FLAGS dwFlags,
    LPCWSTR lpwstrFilename,
    DWORD* lpdwHandle
);

[DllImport("VERSION.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetFileVersionInfoSizeExW(
    uint dwFlags,   // GET_FILE_VERSION_INFO_FLAGS
    [MarshalAs(UnmanagedType.LPWStr)] string lpwstrFilename,   // LPCWSTR
    out uint lpdwHandle   // DWORD* out
);

<DllImport("VERSION.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetFileVersionInfoSizeExW(
    dwFlags As UInteger,   ' GET_FILE_VERSION_INFO_FLAGS
    <MarshalAs(UnmanagedType.LPWStr)> lpwstrFilename As String,   ' LPCWSTR
    <Out> ByRef lpdwHandle As UInteger   ' DWORD* out
) As UInteger
End Function

' dwFlags : GET_FILE_VERSION_INFO_FLAGS
' lpwstrFilename : LPCWSTR
' lpdwHandle : DWORD* out
Declare PtrSafe Function GetFileVersionInfoSizeExW Lib "version" ( _
    ByVal dwFlags As Long, _
    ByVal lpwstrFilename As LongPtr, _
    ByRef lpdwHandle 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

GetFileVersionInfoSizeExW = ctypes.windll.version.GetFileVersionInfoSizeExW
GetFileVersionInfoSizeExW.restype = wintypes.DWORD
GetFileVersionInfoSizeExW.argtypes = [
    wintypes.DWORD,  # dwFlags : GET_FILE_VERSION_INFO_FLAGS
    wintypes.LPCWSTR,  # lpwstrFilename : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # lpdwHandle : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('VERSION.dll')
GetFileVersionInfoSizeExW = Fiddle::Function.new(
  lib['GetFileVersionInfoSizeExW'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : GET_FILE_VERSION_INFO_FLAGS
    Fiddle::TYPE_VOIDP,  # lpwstrFilename : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpdwHandle : DWORD* out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "version")]
extern "system" {
    fn GetFileVersionInfoSizeExW(
        dwFlags: u32,  // GET_FILE_VERSION_INFO_FLAGS
        lpwstrFilename: *const u16,  // LPCWSTR
        lpdwHandle: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("VERSION.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint GetFileVersionInfoSizeExW(uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] string lpwstrFilename, out uint lpdwHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'VERSION_GetFileVersionInfoSizeExW' -Namespace Win32 -PassThru
# $api::GetFileVersionInfoSizeExW(dwFlags, lpwstrFilename, lpdwHandle)

#uselib "VERSION.dll"
#func global GetFileVersionInfoSizeExW "GetFileVersionInfoSizeExW" wptr, wptr, wptr
; GetFileVersionInfoSizeExW dwFlags, lpwstrFilename, varptr(lpdwHandle)   ; 戻り値は stat
; dwFlags : GET_FILE_VERSION_INFO_FLAGS -> "wptr"
; lpwstrFilename : LPCWSTR -> "wptr"
; lpdwHandle : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "VERSION.dll"
#cfunc global GetFileVersionInfoSizeExW "GetFileVersionInfoSizeExW" int, wstr, var
; res = GetFileVersionInfoSizeExW(dwFlags, lpwstrFilename, lpdwHandle)
; dwFlags : GET_FILE_VERSION_INFO_FLAGS -> "int"
; lpwstrFilename : LPCWSTR -> "wstr"
; lpdwHandle : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "VERSION.dll"
#cfunc global GetFileVersionInfoSizeExW "GetFileVersionInfoSizeExW" int, wstr, sptr
; res = GetFileVersionInfoSizeExW(dwFlags, lpwstrFilename, varptr(lpdwHandle))
; dwFlags : GET_FILE_VERSION_INFO_FLAGS -> "int"
; lpwstrFilename : LPCWSTR -> "wstr"
; lpdwHandle : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。