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

GetFileVersionInfoExA

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

シグネチャ

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

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

パラメーター

名前方向説明
dwFlagsGET_FILE_VERSION_INFO_FLAGSin

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

意味
FILE_VER_GET_LOCALISED
0x01
バージョンリソース全体(文字列とバイナリ形式のバージョン情報の両方)を、対応する MUI ファイルが存在する場合はそこから読み込みます。
FILE_VER_GET_NEUTRAL
0x02
バージョンリソースの文字列を、対応する MUI ファイルが存在する場合はそこから読み込み、バイナリ形式のバージョン情報(VS_FIXEDFILEINFO)を、対応する言語ニュートラルファイルが存在する場合はそこから読み込みます。
FILE_VER_GET_PREFETCHED
0x04
競合を回避するため、version.dll がローダーロックの外でイメージのプリロードを試みるよう指定します。このフラグは関数の動作やセマンティクスを変更しません。
lpwstrFilenameLPCSTRinファイルの名前です。フルパスを指定しない場合、関数は LoadLibrary 関数で指定される検索順序を使用します。
dwHandleDWORDoptionalこのパラメーターは予約されており、ゼロ(0)である必要があります。
dwLenDWORDin

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

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

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

lpDatavoid*out

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

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

型: 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  (ANSI / -A)
#include <windows.h>

BOOL GetFileVersionInfoExA(
    GET_FILE_VERSION_INFO_FLAGS dwFlags,
    LPCSTR lpwstrFilename,
    DWORD dwHandle,   // optional
    DWORD dwLen,
    void* lpData
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("VERSION.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetFileVersionInfoExA(
    uint dwFlags,   // GET_FILE_VERSION_INFO_FLAGS
    [MarshalAs(UnmanagedType.LPStr)] string lpwstrFilename,   // LPCSTR
    uint dwHandle,   // DWORD optional
    uint dwLen,   // DWORD
    IntPtr lpData   // void* out
);
<DllImport("VERSION.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetFileVersionInfoExA(
    dwFlags As UInteger,   ' GET_FILE_VERSION_INFO_FLAGS
    <MarshalAs(UnmanagedType.LPStr)> lpwstrFilename As String,   ' LPCSTR
    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 : LPCSTR
' dwHandle : DWORD optional
' dwLen : DWORD
' lpData : void* out
Declare PtrSafe Function GetFileVersionInfoExA Lib "version" ( _
    ByVal dwFlags As Long, _
    ByVal lpwstrFilename As String, _
    ByVal dwHandle As Long, _
    ByVal dwLen As Long, _
    ByVal lpData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetFileVersionInfoExA = ctypes.windll.version.GetFileVersionInfoExA
GetFileVersionInfoExA.restype = wintypes.BOOL
GetFileVersionInfoExA.argtypes = [
    wintypes.DWORD,  # dwFlags : GET_FILE_VERSION_INFO_FLAGS
    wintypes.LPCSTR,  # lpwstrFilename : LPCSTR
    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')
GetFileVersionInfoExA = Fiddle::Function.new(
  lib['GetFileVersionInfoExA'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : GET_FILE_VERSION_INFO_FLAGS
    Fiddle::TYPE_VOIDP,  # lpwstrFilename : LPCSTR
    -Fiddle::TYPE_INT,  # dwHandle : DWORD optional
    -Fiddle::TYPE_INT,  # dwLen : DWORD
    Fiddle::TYPE_VOIDP,  # lpData : void* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "version")]
extern "system" {
    fn GetFileVersionInfoExA(
        dwFlags: u32,  // GET_FILE_VERSION_INFO_FLAGS
        lpwstrFilename: *const u8,  // LPCSTR
        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.Ansi, SetLastError = true)]
public static extern bool GetFileVersionInfoExA(uint dwFlags, [MarshalAs(UnmanagedType.LPStr)] string lpwstrFilename, uint dwHandle, uint dwLen, IntPtr lpData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'VERSION_GetFileVersionInfoExA' -Namespace Win32 -PassThru
# $api::GetFileVersionInfoExA(dwFlags, lpwstrFilename, dwHandle, dwLen, lpData)
#uselib "VERSION.dll"
#func global GetFileVersionInfoExA "GetFileVersionInfoExA" sptr, sptr, sptr, sptr, sptr
; GetFileVersionInfoExA dwFlags, lpwstrFilename, dwHandle, dwLen, lpData   ; 戻り値は stat
; dwFlags : GET_FILE_VERSION_INFO_FLAGS -> "sptr"
; lpwstrFilename : LPCSTR -> "sptr"
; dwHandle : DWORD optional -> "sptr"
; dwLen : DWORD -> "sptr"
; lpData : void* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "VERSION.dll"
#cfunc global GetFileVersionInfoExA "GetFileVersionInfoExA" int, str, int, int, sptr
; res = GetFileVersionInfoExA(dwFlags, lpwstrFilename, dwHandle, dwLen, lpData)
; dwFlags : GET_FILE_VERSION_INFO_FLAGS -> "int"
; lpwstrFilename : LPCSTR -> "str"
; dwHandle : DWORD optional -> "int"
; dwLen : DWORD -> "int"
; lpData : void* out -> "sptr"
; BOOL GetFileVersionInfoExA(GET_FILE_VERSION_INFO_FLAGS dwFlags, LPCSTR lpwstrFilename, DWORD dwHandle, DWORD dwLen, void* lpData)
#uselib "VERSION.dll"
#cfunc global GetFileVersionInfoExA "GetFileVersionInfoExA" int, str, int, int, intptr
; res = GetFileVersionInfoExA(dwFlags, lpwstrFilename, dwHandle, dwLen, lpData)
; dwFlags : GET_FILE_VERSION_INFO_FLAGS -> "int"
; lpwstrFilename : LPCSTR -> "str"
; dwHandle : DWORD optional -> "int"
; dwLen : DWORD -> "int"
; lpData : void* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	version = windows.NewLazySystemDLL("VERSION.dll")
	procGetFileVersionInfoExA = version.NewProc("GetFileVersionInfoExA")
)

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

extern "version" fn GetFileVersionInfoExA(
    dwFlags: u32, // GET_FILE_VERSION_INFO_FLAGS
    lpwstrFilename: [*c]const u8, // LPCSTR
    dwHandle: u32, // DWORD optional
    dwLen: u32, // DWORD
    lpData: ?*anyopaque // void* out
) callconv(std.os.windows.WINAPI) i32;
proc GetFileVersionInfoExA(
    dwFlags: uint32,  # GET_FILE_VERSION_INFO_FLAGS
    lpwstrFilename: cstring,  # LPCSTR
    dwHandle: uint32,  # DWORD optional
    dwLen: uint32,  # DWORD
    lpData: pointer  # void* out
): int32 {.importc: "GetFileVersionInfoExA", stdcall, dynlib: "VERSION.dll".}
pragma(lib, "version");
extern(Windows)
int GetFileVersionInfoExA(
    uint dwFlags,   // GET_FILE_VERSION_INFO_FLAGS
    const(char)* lpwstrFilename,   // LPCSTR
    uint dwHandle,   // DWORD optional
    uint dwLen,   // DWORD
    void* lpData   // void* out
);
ccall((:GetFileVersionInfoExA, "VERSION.dll"), stdcall, Int32,
      (UInt32, Cstring, UInt32, UInt32, Ptr{Cvoid}),
      dwFlags, lpwstrFilename, dwHandle, dwLen, lpData)
# dwFlags : GET_FILE_VERSION_INFO_FLAGS -> UInt32
# lpwstrFilename : LPCSTR -> Cstring
# dwHandle : DWORD optional -> UInt32
# dwLen : DWORD -> UInt32
# lpData : void* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetFileVersionInfoExA(
    uint32_t dwFlags,
    const char* lpwstrFilename,
    uint32_t dwHandle,
    uint32_t dwLen,
    void* lpData);
]]
local version = ffi.load("version")
-- version.GetFileVersionInfoExA(dwFlags, lpwstrFilename, dwHandle, dwLen, lpData)
-- dwFlags : GET_FILE_VERSION_INFO_FLAGS
-- lpwstrFilename : LPCSTR
-- dwHandle : DWORD optional
-- dwLen : DWORD
-- lpData : void* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('VERSION.dll');
const GetFileVersionInfoExA = lib.func('__stdcall', 'GetFileVersionInfoExA', 'int32_t', ['uint32_t', 'str', 'uint32_t', 'uint32_t', 'void *']);
// GetFileVersionInfoExA(dwFlags, lpwstrFilename, dwHandle, dwLen, lpData)
// dwFlags : GET_FILE_VERSION_INFO_FLAGS -> 'uint32_t'
// lpwstrFilename : LPCSTR -> 'str'
// dwHandle : DWORD optional -> 'uint32_t'
// dwLen : DWORD -> 'uint32_t'
// lpData : void* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("VERSION.dll", {
  GetFileVersionInfoExA: { parameters: ["u32", "buffer", "u32", "u32", "pointer"], result: "i32" },
});
// lib.symbols.GetFileVersionInfoExA(dwFlags, lpwstrFilename, dwHandle, dwLen, lpData)
// dwFlags : GET_FILE_VERSION_INFO_FLAGS -> "u32"
// lpwstrFilename : LPCSTR -> "buffer"
// dwHandle : DWORD optional -> "u32"
// dwLen : DWORD -> "u32"
// lpData : void* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetFileVersionInfoExA(
    uint32_t dwFlags,
    const char* lpwstrFilename,
    uint32_t dwHandle,
    uint32_t dwLen,
    void* lpData);
C, "VERSION.dll");
// $ffi->GetFileVersionInfoExA(dwFlags, lpwstrFilename, dwHandle, dwLen, lpData);
// dwFlags : GET_FILE_VERSION_INFO_FLAGS
// lpwstrFilename : LPCSTR
// 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.ASCII_OPTIONS);
    boolean GetFileVersionInfoExA(
        int dwFlags,   // GET_FILE_VERSION_INFO_FLAGS
        String lpwstrFilename,   // LPCSTR
        int dwHandle,   // DWORD optional
        int dwLen,   // DWORD
        Pointer lpData   // void* out
    );
}
@[Link("version")]
lib LibVERSION
  fun GetFileVersionInfoExA = GetFileVersionInfoExA(
    dwFlags : UInt32,   # GET_FILE_VERSION_INFO_FLAGS
    lpwstrFilename : UInt8*,   # LPCSTR
    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 GetFileVersionInfoExANative = Int32 Function(Uint32, Pointer<Utf8>, Uint32, Uint32, Pointer<Void>);
typedef GetFileVersionInfoExADart = int Function(int, Pointer<Utf8>, int, int, Pointer<Void>);
final GetFileVersionInfoExA = DynamicLibrary.open('VERSION.dll')
    .lookupFunction<GetFileVersionInfoExANative, GetFileVersionInfoExADart>('GetFileVersionInfoExA');
// dwFlags : GET_FILE_VERSION_INFO_FLAGS -> Uint32
// lpwstrFilename : LPCSTR -> Pointer<Utf8>
// dwHandle : DWORD optional -> Uint32
// dwLen : DWORD -> Uint32
// lpData : void* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetFileVersionInfoExA(
  dwFlags: DWORD;   // GET_FILE_VERSION_INFO_FLAGS
  lpwstrFilename: PAnsiChar;   // LPCSTR
  dwHandle: DWORD;   // DWORD optional
  dwLen: DWORD;   // DWORD
  lpData: Pointer   // void* out
): BOOL; stdcall;
  external 'VERSION.dll' name 'GetFileVersionInfoExA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getfileversioninfoexa =
  foreign "GetFileVersionInfoExA"
    (uint32_t @-> string @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* dwFlags : GET_FILE_VERSION_INFO_FLAGS -> uint32_t *)
(* lpwstrFilename : LPCSTR -> string *)
(* 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 ("GetFileVersionInfoExA" get-file-version-info-ex-a :convention :stdcall) :int32
  (dw-flags :uint32)   ; GET_FILE_VERSION_INFO_FLAGS
  (lpwstr-filename :string)   ; LPCSTR
  (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 $GetFileVersionInfoExA = Win32::API::More->new('VERSION',
    'BOOL GetFileVersionInfoExA(DWORD dwFlags, LPCSTR lpwstrFilename, DWORD dwHandle, DWORD dwLen, LPVOID lpData)');
# my $ret = $GetFileVersionInfoExA->Call($dwFlags, $lpwstrFilename, $dwHandle, $dwLen, $lpData);
# dwFlags : GET_FILE_VERSION_INFO_FLAGS -> DWORD
# lpwstrFilename : LPCSTR -> LPCSTR
# dwHandle : DWORD optional -> DWORD
# dwLen : DWORD -> DWORD
# lpData : void* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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