VerQueryValue

The VerQueryValue function returns selected version information from the specified version-information resource. To retrieve the appropriate resource, before you call VerQueryValue, you must first call the GetFileVersionInfoSize function, and then the GetFileVersionInfo function.

As with the other file installation functions, VerQueryValue works only with Win32 file images. It does not work with 16-bit Windows file images.

BOOL VerQueryValue(
  const LPVOID pBlock, // address of buffer for version resource
  LPTSTR lpSubBlock,   // address of value to retrieve
  LPVOID *lplpBuffer,  // address of buffer for version value pointer
  PUINT puLen          // address of length buffer
);

Parameters

pBlock

Pointer to the buffer containing the version-information resource returned by the GetFileVersionInfo function.

lpSubBlock

Pointer to a zero-terminated string specifying which version-information value to retrieve. The string must consist of names separated by backslashes (\) and it must have one of the following forms:

Form	Description
\	Specifies the root block. The function retrieves a pointer to the VS_FIXEDFILEINFO structure for the version-information resource.
\VarFileInfo\Translation	Specifies the translation array in a Var variable information structure. The function retrieves a pointer to an array of language and code page identifiers. An application can use these identifiers to access a language-specific StringTable structure in the version-information resource.
\StringFileInfo\lang-codepage\string-name	Specifies a value in a language-specific StringTable structure. The lang-codepage name is a concatenation of a language and code page identifier pair found as a DWORD in the translation array for the resource. Here the lang-codepage name must be specified as a hexadecimal string. The string-name name must be one of the predefined strings described in the following Remarks section. The function retrieves a string value specific to the language and code page indicated.

lplpBuffer

Pointer to a variable that receives a pointer to the requested version information in the buffer pointed to by pBlock. The memory pointed to by *lplpBuffer is freed when the associated pBlock memory is freed.

puLen

Pointer to a buffer that receives the length, in characters, of the version-information value.

Return Values

If the specified version-information structure exists, and version information is available, the return value is nonzero. If the address of the length buffer is zero, no value is available for the specified version-information name.

If the specified name does not exist or the specified resource is not valid, the return value is zero.

Remarks

The Win32 API contains the following predefined version information Unicode strings:

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

The following example shows how to retrieve the FileDescription string-value from a block of version information, if the language is U.S. English and the code page is Windows Multilingual:

VerQueryValue(pBlock, 
              TEXT("\\StringFileInfo\\040904E4\\FileDescription"), 
              &lpBuffer, 
              &dwBytes);

Call the GetFileVersionInfoSize and GetFileVersionInfo functions before calling the VerQueryValue function to properly initialize the pBlock buffer.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in winver.h.
  Import Library: Use version.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

VerQueryValue

Parameters

Return Values

Remarks

QuickInfo

See Also