GetFileSize

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function obtains the size, in bytes, of the specified file. A RAPI version of this function exists called CeGetFileSize (RAPI).

Syntax

DWORD GetFileSize( 
  HANDLE hFile, 
  LPDWORD lpFileSizeHigh
); 

Parameters

• hFile
  [in] Open handle to the file whose size is being returned. The handle must have been created with either GENERIC_READ or GENERIC_WRITE access to the file.

• lpFileSizeHigh
  [out] Pointer to the variable where the high-order word of the file size is returned. This parameter can be set to NULL if the application does not require the high-order word.

Return Value

The low-order DWORD of the file size indicates success. If lpFileSizeHigh is not set to NULL, the function puts the high-order DWORD of the file size into the variable pointed to by that parameter. If lpFileSizeHigh is set to NULL, 0xFFFFFFFF indicates failure. To get extended error information, call GetLastError.

If lpFileSizeHigh is not set to NULL, 0xFFFFFFFF indicates failure, and GetLastError returns a value other than NO_ERROR.

Remarks

If the return value is 0xFFFFFFFF and lpFileSizeHigh is not set to NULL, an application must call GetLastError to determine whether the function has succeeded or failed. The following code example demonstrates this:

// 
// Case One: calling the function with lpFileSizeHigh == NULL.
// Try to obtain the size of hFile.
dwSize = GetFileSize (hFile, NULL);
// Result on failure.
if (dwSize == 0xFFFFFFFF)
{
   // Obtain the error code.
   dwError = GetLastError();
   // Resolve the failure.
   } // End of error handler.
// 
// Case Two: calling the function with lpFileSizeHigh != NULL.
// Try to obtain the size of hFile.
dwSizeLow = GetFileSize (hFile, & dwSizeHigh);
// Result on failure.
if (dwSizeLow == 0xFFFFFFFF && (dwError = GetLastError()) != NO_ERROR )
{
   // Resolve the failure.
}
// End of error handler. 

Requirements

See Also

Reference

File I/O Functions
FindFirstFile
GetFileInformationByHandle