ホーム › Storage.FileSystem › VerQueryValueA

VerQueryValueA

関数

バージョン情報ブロックから指定値を取得する(ANSI版)。

DLLVERSION.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL VerQueryValueA(
    const void* pBlock,
    LPCSTR lpSubBlock,
    void** lplpBuffer,
    DWORD* puLen
);

パラメーター

名前	型	方向	説明
pBlock	void*	in	GetFileVersionInfo 関数によって返されたバージョン情報リソースです。
lpSubBlock	LPCSTR	in	取得するバージョン情報の値です。文字列は円記号 (\) で区切られた名前で構成され、次のいずれかの形式である必要があります。 \ ルートブロックです。この関数は、バージョン情報リソースの VS_FIXEDFILEINFO 構造体へのポインターを取得します。 \VarFileInfo\Translation Var 変数情報構造体内の翻訳配列、すなわちこの構造体の Value メンバーです。この関数は、言語識別子とコードページ識別子のこの配列へのポインターを取得します。アプリケーションはこれらの識別子を使用して、バージョン情報リソース内の言語固有の StringTable 構造体に (szKey メンバーを使用して) アクセスできます。 \StringFileInfo\lang-codepage\string-name 言語固有の StringTable 構造体内の値です。lang-codepage 名は、リソースの翻訳配列内に DWORD として存在する言語識別子とコードページ識別子の組を連結したものです。ここで lang-codepage 名は 16 進数の文字列として指定する必要があります。string-name 名は、後述の「解説」セクションで説明する定義済み文字列のいずれかである必要があります。この関数は、指定された言語とコードページに固有の文字列値を取得します。
lplpBuffer	void**	out	このメソッドが返ると、pBlock が指すバッファー内の要求されたバージョン情報へのポインターのアドレスが格納されます。lplpBuffer が指すメモリは、関連付けられた pBlock メモリが解放されると解放されます。
puLen	DWORD*	out	このメソッドが返ると、lplpBuffer が指す要求されたデータのサイズへのポインターが格納されます。バージョン情報の値の場合は lplpBuffer に格納された文字列の文字数での長さ、翻訳配列の値の場合は lplpBuffer に格納された配列のバイト単位のサイズ、ルートブロックの場合は構造体のバイト単位のサイズです。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

型: 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 ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして VerQueryValue を定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、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 VerQueryValueA(
    const void* pBlock,
    LPCSTR lpSubBlock,
    void** lplpBuffer,
    DWORD* puLen
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("VERSION.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool VerQueryValueA(
    IntPtr pBlock,   // void*
    [MarshalAs(UnmanagedType.LPStr)] string lpSubBlock,   // LPCSTR
    IntPtr lplpBuffer,   // void** out
    out uint puLen   // DWORD* out
);

<DllImport("VERSION.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function VerQueryValueA(
    pBlock As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPStr)> lpSubBlock As String,   ' LPCSTR
    lplpBuffer As IntPtr,   ' void** out
    <Out> ByRef puLen As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pBlock : void*
' lpSubBlock : LPCSTR
' lplpBuffer : void** out
' puLen : DWORD* out
Declare PtrSafe Function VerQueryValueA Lib "version" ( _
    ByVal pBlock As LongPtr, _
    ByVal lpSubBlock As String, _
    ByVal lplpBuffer As LongPtr, _
    ByRef puLen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

VerQueryValueA = ctypes.windll.version.VerQueryValueA
VerQueryValueA.restype = wintypes.BOOL
VerQueryValueA.argtypes = [
    ctypes.POINTER(None),  # pBlock : void*
    wintypes.LPCSTR,  # lpSubBlock : LPCSTR
    ctypes.c_void_p,  # lplpBuffer : void** out
    ctypes.POINTER(wintypes.DWORD),  # puLen : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('VERSION.dll')
VerQueryValueA = Fiddle::Function.new(
  lib['VerQueryValueA'],
  [
    Fiddle::TYPE_VOIDP,  # pBlock : void*
    Fiddle::TYPE_VOIDP,  # lpSubBlock : LPCSTR
    Fiddle::TYPE_VOIDP,  # lplpBuffer : void** out
    Fiddle::TYPE_VOIDP,  # puLen : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "version")]
extern "system" {
    fn VerQueryValueA(
        pBlock: *const (),  // void*
        lpSubBlock: *const u8,  // LPCSTR
        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.Ansi)]
public static extern bool VerQueryValueA(IntPtr pBlock, [MarshalAs(UnmanagedType.LPStr)] string lpSubBlock, IntPtr lplpBuffer, out uint puLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'VERSION_VerQueryValueA' -Namespace Win32 -PassThru
# $api::VerQueryValueA(pBlock, lpSubBlock, lplpBuffer, puLen)

#uselib "VERSION.dll"
#func global VerQueryValueA "VerQueryValueA" sptr, sptr, sptr, sptr
; VerQueryValueA pBlock, lpSubBlock, lplpBuffer, varptr(puLen)   ; 戻り値は stat
; pBlock : void* -> "sptr"
; lpSubBlock : LPCSTR -> "sptr"
; lplpBuffer : void** out -> "sptr"
; puLen : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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