GetFileVersionInfo

The GetFileVersionInfo function returns version information about a specified file.

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

BOOL GetFileVersionInfo(
  LPTSTR lptstrFilename,  // pointer to filename string
  DWORD dwHandle,         // ignored
  DWORD dwLen,            // size of buffer
  LPVOID lpData           // pointer to buffer to receive 
                          // file-version info.
);
 

Parameters

lptstrFilename

Pointer to a null-terminated filename string that specifies the file of interest.

Windows 95 and Windows 98: The short path form of the specified file name must be less than 126 characters.

dwHandle

This parameter is ignored.

dwLen

Specifies the size, in bytes, of the buffer pointed to by the lpData member.

Call the GetFileVersionInfoSize function first to determine the size, in bytes, of a file's version information. The dwLen member should be equal to or greater than that value.

If the buffer pointed to by lpData is not large enough, the function truncates the file's version information to the size of the buffer.

lpData

Pointer to a buffer to receive file-version information.

You can use this value in a subsequent call to the VerQueryValue function to retrieve data from the buffer.

The file version information is always in Unicode format.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Call the GetFileVersionInfoSize function before calling the GetFileVersionInfo function. The file-version information has the format indicated by the VS_VERSIONINFO structure.

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.

See Also

File Installation Library Overview, File Installation Library Functions, GetFileVersionInfoSize, VerQueryValue, VS_VERSIONINFO