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

VerQueryValueW

関数
バージョン情報ブロックから指定値を取得する。
DLLVERSION.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL VerQueryValueW(
    const void* pBlock,
    LPCWSTR lpSubBlock,
    void** lplpBuffer,
    DWORD* puLen
);

パラメーター

名前方向説明
pBlockvoid*inGetFileVersionInfo 関数が返したバージョン情報リソースです。
lpSubBlockLPCWSTRin

取得するバージョン情報の値です。文字列はバックスラッシュ (\) で区切られた名前で構成され、次のいずれかの形式である必要があります。

\

ルートブロックです。この関数は、バージョン情報リソースの VS_FIXEDFILEINFO 構造体へのポインターを取得します。

\VarFileInfo\Translation

Var 可変情報構造体内の変換配列、すなわちこの構造体の Value メンバーです。この関数は、言語識別子とコードページ識別子からなるこの配列へのポインターを取得します。アプリケーションはこれらの識別子を使用して、バージョン情報リソース内の言語固有の StringTable 構造体に (szKey メンバーを介して) アクセスできます。

\StringFileInfo\lang-codepage\string-name

言語固有の StringTable 構造体内の値です。lang-codepage 名は、リソースの変換配列内に DWORD として格納されている言語識別子とコードページ識別子のペアを連結したものです。ここで lang-codepage 名は 16 進文字列として指定する必要があります。string-name 名は、後述の「解説」セクションで説明する定義済み文字列のいずれかである必要があります。この関数は、指定された言語およびコードページに固有の文字列値を取得します。

lplpBuffervoid**outこのメソッドが返ると、pBlock が指すバッファー内の、要求したバージョン情報へのポインターのアドレスが格納されます。lplpBuffer が指すメモリは、対応する pBlock のメモリが解放されたときに解放されます。
puLenDWORD*out

このメソッドが返ると、lplpBuffer が指す要求データのサイズへのポインターが格納されます。バージョン情報値の場合は lplpBuffer に格納された文字列の文字数での長さ、変換配列値の場合は lplpBuffer に格納された配列のバイト単位のサイズ、ルートブロックの場合は構造体のバイト単位のサイズです。

- lpSubBlock.\

ルートブロックです。この関数は、バージョン情報リソースの VS_FIXEDFILEINFO 構造体へのポインターを取得します。

- lpSubBlock.\StringFileInfo\lang-codepage\string-name

言語固有の StringTable 構造体内の値です。lang-codepage 名は、リソースの変換配列内に DWORD として格納されている言語識別子とコードページ識別子のペアを連結したものです。ここで lang-codepage 名は 16 進文字列として指定する必要があります。string-name 名は、後述の「解説」セクションで説明する定義済み文字列のいずれかである必要があります。この関数は、指定された言語およびコードページに固有の文字列値を取得します。

- lpSubBlock.\VarFileInfo\Translation

Var 可変情報構造体内の変換配列、すなわちこの構造体の Value メンバーです。この関数は、言語識別子とコードページ識別子からなるこの配列へのポインターを取得します。アプリケーションはこれらの識別子を使用して、バージョン情報リソース内の言語固有の StringTable 構造体に (szKey メンバーを介して) アクセスできます。

戻り値の型: BOOL

公式ドキュメント

指定したバージョン情報リソースから、指定したバージョン情報を取得します。(Unicode)

戻り値

型: BOOL

指定したバージョン情報構造体が存在し、バージョン情報が利用可能な場合、戻り値は 0 以外になります。長さバッファーのアドレスが 0 の場合、指定したバージョン情報名に対する値は利用できません。

指定した名前が存在しない場合、または指定したリソースが有効でない場合、戻り値は 0 になります。

解説(Remarks)

この関数は、16 ビット、32 ビット、64 ビットのファイルイメージで動作します。

以下は、定義済みのバージョン情報 Unicode 文字列です。

Comments InternalName ProductName
CompanyName LegalCopyright ProductVersion
FileDescription LegalTrademarks PrivateBuild
FileVersion OriginalFilename SpecialBuild

次の例は、利用可能なバージョンの言語を列挙し、各言語について FileDescription の文字列値を取得する方法を示しています。

pBlock バッファーを適切に初期化するため、VerQueryValue を呼び出す前に GetFileVersionInfoSize 関数および GetFileVersionInfo 関数を必ず呼び出してください。

// Structure used to store enumerated languages and code pages.

HRESULT hr;

struct LANGANDCODEPAGE {
  WORD wLanguage;
  WORD wCodePage;
} *lpTranslate;

// Read the list of languages and code pages.

VerQueryValue(pBlock, 
              TEXT("\\VarFileInfo\\Translation"),
              (LPVOID*)&lpTranslate,
              &cbTranslate);

// Read the file description for each language and code page.

for( i=0; i < (cbTranslate/sizeof(struct LANGANDCODEPAGE)); i++ )
{
  hr = StringCchPrintf(SubBlock, 50,
            TEXT("\\StringFileInfo\\%04x%04x\\FileDescription"),
            lpTranslate[i].wLanguage,
            lpTranslate[i].wCodePage);
    if (FAILED(hr))
    {
    // TODO: write error handler.
    }

  // Retrieve file description for language and code page "i". 
  VerQueryValue(pBlock, 
                SubBlock, 
                &lpBuffer, 
                &dwBytes); 
}
メモ

winver.h ヘッダーは VerQueryValue をエイリアスとして定義しており、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 VerQueryValueW(
    const void* pBlock,
    LPCWSTR lpSubBlock,
    void** lplpBuffer,
    DWORD* puLen
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("VERSION.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool VerQueryValueW(
    IntPtr pBlock,   // void*
    [MarshalAs(UnmanagedType.LPWStr)] string lpSubBlock,   // LPCWSTR
    IntPtr lplpBuffer,   // void** out
    out uint puLen   // DWORD* out
);
<DllImport("VERSION.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function VerQueryValueW(
    pBlock As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPWStr)> lpSubBlock As String,   ' LPCWSTR
    lplpBuffer As IntPtr,   ' void** out
    <Out> ByRef puLen As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pBlock : void*
' lpSubBlock : LPCWSTR
' lplpBuffer : void** out
' puLen : DWORD* out
Declare PtrSafe Function VerQueryValueW Lib "version" ( _
    ByVal pBlock As LongPtr, _
    ByVal lpSubBlock As LongPtr, _
    ByVal lplpBuffer As LongPtr, _
    ByRef puLen 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

VerQueryValueW = ctypes.windll.version.VerQueryValueW
VerQueryValueW.restype = wintypes.BOOL
VerQueryValueW.argtypes = [
    ctypes.POINTER(None),  # pBlock : void*
    wintypes.LPCWSTR,  # lpSubBlock : LPCWSTR
    ctypes.c_void_p,  # lplpBuffer : void** out
    ctypes.POINTER(wintypes.DWORD),  # puLen : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('VERSION.dll')
VerQueryValueW = Fiddle::Function.new(
  lib['VerQueryValueW'],
  [
    Fiddle::TYPE_VOIDP,  # pBlock : void*
    Fiddle::TYPE_VOIDP,  # lpSubBlock : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lplpBuffer : void** out
    Fiddle::TYPE_VOIDP,  # puLen : DWORD* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "version")]
extern "system" {
    fn VerQueryValueW(
        pBlock: *const (),  // void*
        lpSubBlock: *const u16,  // LPCWSTR
        lplpBuffer: *mut *mut (),  // void** out
        puLen: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("VERSION.dll", CharSet = CharSet.Unicode)]
public static extern bool VerQueryValueW(IntPtr pBlock, [MarshalAs(UnmanagedType.LPWStr)] string lpSubBlock, IntPtr lplpBuffer, out uint puLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'VERSION_VerQueryValueW' -Namespace Win32 -PassThru
# $api::VerQueryValueW(pBlock, lpSubBlock, lplpBuffer, puLen)
#uselib "VERSION.dll"
#func global VerQueryValueW "VerQueryValueW" wptr, wptr, wptr, wptr
; VerQueryValueW pBlock, lpSubBlock, lplpBuffer, varptr(puLen)   ; 戻り値は stat
; pBlock : void* -> "wptr"
; lpSubBlock : LPCWSTR -> "wptr"
; lplpBuffer : void** out -> "wptr"
; puLen : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "VERSION.dll"
#cfunc global VerQueryValueW "VerQueryValueW" sptr, wstr, sptr, var
; res = VerQueryValueW(pBlock, lpSubBlock, lplpBuffer, puLen)
; pBlock : void* -> "sptr"
; lpSubBlock : LPCWSTR -> "wstr"
; lplpBuffer : void** out -> "sptr"
; puLen : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL VerQueryValueW(void* pBlock, LPCWSTR lpSubBlock, void** lplpBuffer, DWORD* puLen)
#uselib "VERSION.dll"
#cfunc global VerQueryValueW "VerQueryValueW" intptr, wstr, intptr, var
; res = VerQueryValueW(pBlock, lpSubBlock, lplpBuffer, puLen)
; pBlock : void* -> "intptr"
; lpSubBlock : LPCWSTR -> "wstr"
; lplpBuffer : void** out -> "intptr"
; puLen : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	version = windows.NewLazySystemDLL("VERSION.dll")
	procVerQueryValueW = version.NewProc("VerQueryValueW")
)

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

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

typedef VerQueryValueWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Void>, Pointer<Uint32>);
typedef VerQueryValueWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Void>, Pointer<Uint32>);
final VerQueryValueW = DynamicLibrary.open('VERSION.dll')
    .lookupFunction<VerQueryValueWNative, VerQueryValueWDart>('VerQueryValueW');
// pBlock : void* -> Pointer<Void>
// lpSubBlock : LPCWSTR -> Pointer<Utf16>
// lplpBuffer : void** out -> Pointer<Void>
// puLen : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function VerQueryValueW(
  pBlock: Pointer;   // void*
  lpSubBlock: PWideChar;   // LPCWSTR
  lplpBuffer: Pointer;   // void** out
  puLen: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'VERSION.dll' name 'VerQueryValueW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "VerQueryValueW"
  c_VerQueryValueW :: Ptr () -> CWString -> Ptr () -> Ptr Word32 -> IO CInt
-- pBlock : void* -> Ptr ()
-- lpSubBlock : LPCWSTR -> CWString
-- lplpBuffer : void** out -> Ptr ()
-- puLen : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let verqueryvaluew =
  foreign "VerQueryValueW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* pBlock : void* -> (ptr void) *)
(* lpSubBlock : LPCWSTR -> (ptr uint16_t) *)
(* lplpBuffer : void** out -> (ptr void) *)
(* puLen : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library version (t "VERSION.dll"))
(cffi:use-foreign-library version)

(cffi:defcfun ("VerQueryValueW" ver-query-value-w :convention :stdcall) :int32
  (p-block :pointer)   ; void*
  (lp-sub-block (:string :encoding :utf-16le))   ; LPCWSTR
  (lplp-buffer :pointer)   ; void** out
  (pu-len :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $VerQueryValueW = Win32::API::More->new('VERSION',
    'BOOL VerQueryValueW(LPVOID pBlock, LPCWSTR lpSubBlock, LPVOID lplpBuffer, LPVOID puLen)');
# my $ret = $VerQueryValueW->Call($pBlock, $lpSubBlock, $lplpBuffer, $puLen);
# pBlock : void* -> LPVOID
# lpSubBlock : LPCWSTR -> LPCWSTR
# lplpBuffer : void** out -> LPVOID
# puLen : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目