Win32 API 日本語リファレンス
ホームStorage.FileSystem › GetFileVersionInfoExW

GetFileVersionInfoExW

関数
フラグ指定でファイルのバージョン情報を取得する。
DLLVERSION.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL GetFileVersionInfoExW(
    GET_FILE_VERSION_INFO_FLAGS dwFlags,
    LPCWSTR lpwstrFilename,
    DWORD dwHandle,   // optional
    DWORD dwLen,
    void* lpData
);

パラメーター

名前方向説明
dwFlagsGET_FILE_VERSION_INFO_FLAGSin

バージョンリソースを抽出する元の MUI DLL(存在する場合)を制御します。このフラグの値は、対応する GetFileVersionInfoSizeEx 呼び出しに渡したフラグと一致している必要があります。その呼び出しは、dwLen パラメーターに渡すバッファーサイズを決定するために使用されたものです。次のフラグを 0 個以上指定します。

Value Meaning
FILE_VER_GET_LOCALISED
0x01
対応する MUI ファイルが利用可能な場合、そのファイルからバージョンリソース全体(文字列とバイナリのバージョン情報の両方)を読み込みます。
FILE_VER_GET_NEUTRAL
0x02
対応する MUI ファイルが利用可能な場合、そのファイルからバージョンリソース文字列を読み込み、対応する言語ニュートラルファイルが利用可能な場合、そのファイルからバイナリのバージョン情報(VS_FIXEDFILEINFO)を読み込みます。
FILE_VER_GET_PREFETCHED
0x04
version.dll が競合を避けるために、ローダーロックの外でイメージのプリロードを試みることを優先する指定です。このフラグは関数の動作やセマンティクスを変更しません。
lpwstrFilenameLPCWSTRinファイルの名前。フルパスを指定しない場合、関数は LoadLibrary 関数が指定する検索シーケンスを使用します。
dwHandleDWORDoptionalこのパラメーターは無視されます。
dwLenDWORDin

lpData パラメーターが指すバッファーのサイズ(バイト単位)。

まず GetFileVersionInfoSizeEx 関数を呼び出して、ファイルのバージョン情報のサイズ(バイト単位)を確認してください。dwLen パラメーターはその値以上である必要があります。

lpData が指すバッファーが十分な大きさでない場合、関数はファイルのバージョン情報をバッファーのサイズに切り詰めます。

lpDatavoid*out

この関数が返るとき、ファイルのバージョン情報を格納したバッファーへのポインターが格納されます。

この値は、後続の VerQueryValue 関数の呼び出しでバッファーからデータを取得するために使用できます。

戻り値の型: BOOL

公式ドキュメント

指定したファイルのバージョン情報を取得します。(GetFileVersionInfoExW)

戻り値

Type: BOOL

関数が成功した場合、戻り値は 0 以外です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

GetFileVersionInfoEx 関数を呼び出す前に、GetFileVersionInfoSizeEx 関数を呼び出してください。ファイルのバージョン情報バッファーから情報を取得するには、VerQueryValue 関数を使用します。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

BOOL GetFileVersionInfoExW(
    GET_FILE_VERSION_INFO_FLAGS dwFlags,
    LPCWSTR lpwstrFilename,
    DWORD dwHandle,   // optional
    DWORD dwLen,
    void* lpData
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("VERSION.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetFileVersionInfoExW(
    uint dwFlags,   // GET_FILE_VERSION_INFO_FLAGS
    [MarshalAs(UnmanagedType.LPWStr)] string lpwstrFilename,   // LPCWSTR
    uint dwHandle,   // DWORD optional
    uint dwLen,   // DWORD
    IntPtr lpData   // void* out
);
<DllImport("VERSION.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetFileVersionInfoExW(
    dwFlags As UInteger,   ' GET_FILE_VERSION_INFO_FLAGS
    <MarshalAs(UnmanagedType.LPWStr)> lpwstrFilename As String,   ' LPCWSTR
    dwHandle As UInteger,   ' DWORD optional
    dwLen As UInteger,   ' DWORD
    lpData As IntPtr   ' void* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' dwFlags : GET_FILE_VERSION_INFO_FLAGS
' lpwstrFilename : LPCWSTR
' dwHandle : DWORD optional
' dwLen : DWORD
' lpData : void* out
Declare PtrSafe Function GetFileVersionInfoExW Lib "version" ( _
    ByVal dwFlags As Long, _
    ByVal lpwstrFilename As LongPtr, _
    ByVal dwHandle As Long, _
    ByVal dwLen As Long, _
    ByVal lpData 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

GetFileVersionInfoExW = ctypes.windll.version.GetFileVersionInfoExW
GetFileVersionInfoExW.restype = wintypes.BOOL
GetFileVersionInfoExW.argtypes = [
    wintypes.DWORD,  # dwFlags : GET_FILE_VERSION_INFO_FLAGS
    wintypes.LPCWSTR,  # lpwstrFilename : LPCWSTR
    wintypes.DWORD,  # dwHandle : DWORD optional
    wintypes.DWORD,  # dwLen : DWORD
    ctypes.POINTER(None),  # lpData : void* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('VERSION.dll')
GetFileVersionInfoExW = Fiddle::Function.new(
  lib['GetFileVersionInfoExW'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : GET_FILE_VERSION_INFO_FLAGS
    Fiddle::TYPE_VOIDP,  # lpwstrFilename : LPCWSTR
    -Fiddle::TYPE_INT,  # dwHandle : DWORD optional
    -Fiddle::TYPE_INT,  # dwLen : DWORD
    Fiddle::TYPE_VOIDP,  # lpData : void* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "version")]
extern "system" {
    fn GetFileVersionInfoExW(
        dwFlags: u32,  // GET_FILE_VERSION_INFO_FLAGS
        lpwstrFilename: *const u16,  // LPCWSTR
        dwHandle: u32,  // DWORD optional
        dwLen: u32,  // DWORD
        lpData: *mut ()  // void* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("VERSION.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool GetFileVersionInfoExW(uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] string lpwstrFilename, uint dwHandle, uint dwLen, IntPtr lpData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'VERSION_GetFileVersionInfoExW' -Namespace Win32 -PassThru
# $api::GetFileVersionInfoExW(dwFlags, lpwstrFilename, dwHandle, dwLen, lpData)
#uselib "VERSION.dll"
#func global GetFileVersionInfoExW "GetFileVersionInfoExW" wptr, wptr, wptr, wptr, wptr
; GetFileVersionInfoExW dwFlags, lpwstrFilename, dwHandle, dwLen, lpData   ; 戻り値は stat
; dwFlags : GET_FILE_VERSION_INFO_FLAGS -> "wptr"
; lpwstrFilename : LPCWSTR -> "wptr"
; dwHandle : DWORD optional -> "wptr"
; dwLen : DWORD -> "wptr"
; lpData : void* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "VERSION.dll"
#cfunc global GetFileVersionInfoExW "GetFileVersionInfoExW" int, wstr, int, int, sptr
; res = GetFileVersionInfoExW(dwFlags, lpwstrFilename, dwHandle, dwLen, lpData)
; dwFlags : GET_FILE_VERSION_INFO_FLAGS -> "int"
; lpwstrFilename : LPCWSTR -> "wstr"
; dwHandle : DWORD optional -> "int"
; dwLen : DWORD -> "int"
; lpData : void* out -> "sptr"
; BOOL GetFileVersionInfoExW(GET_FILE_VERSION_INFO_FLAGS dwFlags, LPCWSTR lpwstrFilename, DWORD dwHandle, DWORD dwLen, void* lpData)
#uselib "VERSION.dll"
#cfunc global GetFileVersionInfoExW "GetFileVersionInfoExW" int, wstr, int, int, intptr
; res = GetFileVersionInfoExW(dwFlags, lpwstrFilename, dwHandle, dwLen, lpData)
; dwFlags : GET_FILE_VERSION_INFO_FLAGS -> "int"
; lpwstrFilename : LPCWSTR -> "wstr"
; dwHandle : DWORD optional -> "int"
; dwLen : DWORD -> "int"
; lpData : void* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	version = windows.NewLazySystemDLL("VERSION.dll")
	procGetFileVersionInfoExW = version.NewProc("GetFileVersionInfoExW")
)

// dwFlags (GET_FILE_VERSION_INFO_FLAGS), lpwstrFilename (LPCWSTR), dwHandle (DWORD optional), dwLen (DWORD), lpData (void* out)
r1, _, err := procGetFileVersionInfoExW.Call(
	uintptr(dwFlags),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpwstrFilename))),
	uintptr(dwHandle),
	uintptr(dwLen),
	uintptr(lpData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetFileVersionInfoExW(
  dwFlags: DWORD;   // GET_FILE_VERSION_INFO_FLAGS
  lpwstrFilename: PWideChar;   // LPCWSTR
  dwHandle: DWORD;   // DWORD optional
  dwLen: DWORD;   // DWORD
  lpData: Pointer   // void* out
): BOOL; stdcall;
  external 'VERSION.dll' name 'GetFileVersionInfoExW';
result := DllCall("VERSION\GetFileVersionInfoExW"
    , "UInt", dwFlags   ; GET_FILE_VERSION_INFO_FLAGS
    , "WStr", lpwstrFilename   ; LPCWSTR
    , "UInt", dwHandle   ; DWORD optional
    , "UInt", dwLen   ; DWORD
    , "Ptr", lpData   ; void* out
    , "Int")   ; return: BOOL
●GetFileVersionInfoExW(dwFlags, lpwstrFilename, dwHandle, dwLen, lpData) = DLL("VERSION.dll", "bool GetFileVersionInfoExW(dword, char*, dword, dword, void*)")
# 呼び出し: GetFileVersionInfoExW(dwFlags, lpwstrFilename, dwHandle, dwLen, lpData)
# dwFlags : GET_FILE_VERSION_INFO_FLAGS -> "dword"
# lpwstrFilename : LPCWSTR -> "char*"
# dwHandle : DWORD optional -> "dword"
# dwLen : DWORD -> "dword"
# lpData : void* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "version" fn GetFileVersionInfoExW(
    dwFlags: u32, // GET_FILE_VERSION_INFO_FLAGS
    lpwstrFilename: [*c]const u16, // LPCWSTR
    dwHandle: u32, // DWORD optional
    dwLen: u32, // DWORD
    lpData: ?*anyopaque // void* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetFileVersionInfoExW(
    dwFlags: uint32,  # GET_FILE_VERSION_INFO_FLAGS
    lpwstrFilename: WideCString,  # LPCWSTR
    dwHandle: uint32,  # DWORD optional
    dwLen: uint32,  # DWORD
    lpData: pointer  # void* out
): int32 {.importc: "GetFileVersionInfoExW", stdcall, dynlib: "VERSION.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "version");
extern(Windows)
int GetFileVersionInfoExW(
    uint dwFlags,   // GET_FILE_VERSION_INFO_FLAGS
    const(wchar)* lpwstrFilename,   // LPCWSTR
    uint dwHandle,   // DWORD optional
    uint dwLen,   // DWORD
    void* lpData   // void* out
);
ccall((:GetFileVersionInfoExW, "VERSION.dll"), stdcall, Int32,
      (UInt32, Cwstring, UInt32, UInt32, Ptr{Cvoid}),
      dwFlags, lpwstrFilename, dwHandle, dwLen, lpData)
# dwFlags : GET_FILE_VERSION_INFO_FLAGS -> UInt32
# lpwstrFilename : LPCWSTR -> Cwstring
# dwHandle : DWORD optional -> UInt32
# dwLen : DWORD -> UInt32
# lpData : void* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetFileVersionInfoExW(
    uint32_t dwFlags,
    const uint16_t* lpwstrFilename,
    uint32_t dwHandle,
    uint32_t dwLen,
    void* lpData);
]]
local version = ffi.load("version")
-- version.GetFileVersionInfoExW(dwFlags, lpwstrFilename, dwHandle, dwLen, lpData)
-- dwFlags : GET_FILE_VERSION_INFO_FLAGS
-- lpwstrFilename : LPCWSTR
-- dwHandle : DWORD optional
-- dwLen : DWORD
-- lpData : void* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('VERSION.dll');
const GetFileVersionInfoExW = lib.func('__stdcall', 'GetFileVersionInfoExW', 'int32_t', ['uint32_t', 'str16', 'uint32_t', 'uint32_t', 'void *']);
// GetFileVersionInfoExW(dwFlags, lpwstrFilename, dwHandle, dwLen, lpData)
// dwFlags : GET_FILE_VERSION_INFO_FLAGS -> 'uint32_t'
// lpwstrFilename : LPCWSTR -> 'str16'
// dwHandle : DWORD optional -> 'uint32_t'
// dwLen : DWORD -> 'uint32_t'
// lpData : void* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("VERSION.dll", {
  GetFileVersionInfoExW: { parameters: ["u32", "buffer", "u32", "u32", "pointer"], result: "i32" },
});
// lib.symbols.GetFileVersionInfoExW(dwFlags, lpwstrFilename, dwHandle, dwLen, lpData)
// dwFlags : GET_FILE_VERSION_INFO_FLAGS -> "u32"
// lpwstrFilename : LPCWSTR -> "buffer"
// dwHandle : DWORD optional -> "u32"
// dwLen : DWORD -> "u32"
// lpData : void* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetFileVersionInfoExW(
    uint32_t dwFlags,
    const uint16_t* lpwstrFilename,
    uint32_t dwHandle,
    uint32_t dwLen,
    void* lpData);
C, "VERSION.dll");
// $ffi->GetFileVersionInfoExW(dwFlags, lpwstrFilename, dwHandle, dwLen, lpData);
// dwFlags : GET_FILE_VERSION_INFO_FLAGS
// lpwstrFilename : LPCWSTR
// dwHandle : DWORD optional
// dwLen : DWORD
// lpData : void* 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 Version extends StdCallLibrary {
    Version INSTANCE = Native.load("version", Version.class, W32APIOptions.UNICODE_OPTIONS);
    boolean GetFileVersionInfoExW(
        int dwFlags,   // GET_FILE_VERSION_INFO_FLAGS
        WString lpwstrFilename,   // LPCWSTR
        int dwHandle,   // DWORD optional
        int dwLen,   // DWORD
        Pointer lpData   // void* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("version")]
lib LibVERSION
  fun GetFileVersionInfoExW = GetFileVersionInfoExW(
    dwFlags : UInt32,   # GET_FILE_VERSION_INFO_FLAGS
    lpwstrFilename : UInt16*,   # LPCWSTR
    dwHandle : UInt32,   # DWORD optional
    dwLen : UInt32,   # DWORD
    lpData : Void*   # void* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetFileVersionInfoExWNative = Int32 Function(Uint32, Pointer<Utf16>, Uint32, Uint32, Pointer<Void>);
typedef GetFileVersionInfoExWDart = int Function(int, Pointer<Utf16>, int, int, Pointer<Void>);
final GetFileVersionInfoExW = DynamicLibrary.open('VERSION.dll')
    .lookupFunction<GetFileVersionInfoExWNative, GetFileVersionInfoExWDart>('GetFileVersionInfoExW');
// dwFlags : GET_FILE_VERSION_INFO_FLAGS -> Uint32
// lpwstrFilename : LPCWSTR -> Pointer<Utf16>
// dwHandle : DWORD optional -> Uint32
// dwLen : DWORD -> Uint32
// lpData : void* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetFileVersionInfoExW(
  dwFlags: DWORD;   // GET_FILE_VERSION_INFO_FLAGS
  lpwstrFilename: PWideChar;   // LPCWSTR
  dwHandle: DWORD;   // DWORD optional
  dwLen: DWORD;   // DWORD
  lpData: Pointer   // void* out
): BOOL; stdcall;
  external 'VERSION.dll' name 'GetFileVersionInfoExW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetFileVersionInfoExW"
  c_GetFileVersionInfoExW :: Word32 -> CWString -> Word32 -> Word32 -> Ptr () -> IO CInt
-- dwFlags : GET_FILE_VERSION_INFO_FLAGS -> Word32
-- lpwstrFilename : LPCWSTR -> CWString
-- dwHandle : DWORD optional -> Word32
-- dwLen : DWORD -> Word32
-- lpData : void* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getfileversioninfoexw =
  foreign "GetFileVersionInfoExW"
    (uint32_t @-> (ptr uint16_t) @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* dwFlags : GET_FILE_VERSION_INFO_FLAGS -> uint32_t *)
(* lpwstrFilename : LPCWSTR -> (ptr uint16_t) *)
(* dwHandle : DWORD optional -> uint32_t *)
(* dwLen : DWORD -> uint32_t *)
(* lpData : void* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library version (t "VERSION.dll"))
(cffi:use-foreign-library version)

(cffi:defcfun ("GetFileVersionInfoExW" get-file-version-info-ex-w :convention :stdcall) :int32
  (dw-flags :uint32)   ; GET_FILE_VERSION_INFO_FLAGS
  (lpwstr-filename (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-handle :uint32)   ; DWORD optional
  (dw-len :uint32)   ; DWORD
  (lp-data :pointer))   ; void* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetFileVersionInfoExW = Win32::API::More->new('VERSION',
    'BOOL GetFileVersionInfoExW(DWORD dwFlags, LPCWSTR lpwstrFilename, DWORD dwHandle, DWORD dwLen, LPVOID lpData)');
# my $ret = $GetFileVersionInfoExW->Call($dwFlags, $lpwstrFilename, $dwHandle, $dwLen, $lpData);
# dwFlags : GET_FILE_VERSION_INFO_FLAGS -> DWORD
# lpwstrFilename : LPCWSTR -> LPCWSTR
# dwHandle : DWORD optional -> DWORD
# dwLen : DWORD -> DWORD
# lpData : void* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
公式の関連項目
使用する型