ホーム › Storage.FileSystem › GetFileVersionInfoSizeW

GetFileVersionInfoSizeW

関数

ファイルのバージョン情報の必要バッファサイズを取得する。

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

シグネチャ

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

DWORD GetFileVersionInfoSizeW(
    LPCWSTR lptstrFilename,
    DWORD* lpdwHandle   // optional
);

パラメーター

名前	型	方向	説明
lptstrFilename	LPCWSTR	in	対象とするファイルの名前。この関数は LoadLibrary 関数で指定される検索順序を使用します。
lpdwHandle	DWORD*	outoptional	関数によってゼロに設定される変数へのポインター。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

型: DWORD

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

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

解説(Remarks)

GetFileVersionInfo 関数を呼び出す前に GetFileVersionInfoSize 関数を呼び出します。GetFileVersionInfoSize が返すサイズは、GetFileVersionInfo が返すバージョン情報に必要なバッファーサイズを示します。

メモ

winver.h ヘッダーは GetFileVersionInfoSize を、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>

DWORD GetFileVersionInfoSizeW(
    LPCWSTR lptstrFilename,
    DWORD* lpdwHandle   // optional
);

[DllImport("VERSION.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetFileVersionInfoSizeW(
    [MarshalAs(UnmanagedType.LPWStr)] string lptstrFilename,   // LPCWSTR
    IntPtr lpdwHandle   // DWORD* optional, out
);

<DllImport("VERSION.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetFileVersionInfoSizeW(
    <MarshalAs(UnmanagedType.LPWStr)> lptstrFilename As String,   ' LPCWSTR
    lpdwHandle As IntPtr   ' DWORD* optional, out
) As UInteger
End Function

' lptstrFilename : LPCWSTR
' lpdwHandle : DWORD* optional, out
Declare PtrSafe Function GetFileVersionInfoSizeW Lib "version" ( _
    ByVal lptstrFilename As LongPtr, _
    ByVal lpdwHandle 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

GetFileVersionInfoSizeW = ctypes.windll.version.GetFileVersionInfoSizeW
GetFileVersionInfoSizeW.restype = wintypes.DWORD
GetFileVersionInfoSizeW.argtypes = [
    wintypes.LPCWSTR,  # lptstrFilename : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # lpdwHandle : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "version")]
extern "system" {
    fn GetFileVersionInfoSizeW(
        lptstrFilename: *const u16,  // LPCWSTR
        lpdwHandle: *mut u32  // DWORD* optional, 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 GetFileVersionInfoSizeW([MarshalAs(UnmanagedType.LPWStr)] string lptstrFilename, IntPtr lpdwHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'VERSION_GetFileVersionInfoSizeW' -Namespace Win32 -PassThru
# $api::GetFileVersionInfoSizeW(lptstrFilename, lpdwHandle)

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

出力引数:

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