Share via


BY_HANDLE_FILE_INFORMATION

This structure contains information retrieved by the GetFileInformationByHandle function.

typedef struct _BY_HANDLE_FILE_INFORMATION { 
DWORD dwFileAttributes; 
FILETIME ftCreationTime; 
FILETIME ftLastAccessTime; 
FILETIME ftLastWriteTime; 
DWORD dwVolumeSerialNumber; 
DWORD nFileSizeHigh; 
DWORD nFileSizeLow; 
DWORD nNumberOfLinks; 
DWORD nFileIndexHigh; 
DWORD nFileIndexLow; 
} BY_HANDLE_FILE_INFORMATION; 

Members

  • dwFileAttributes
    Specifies file attributes. It can be one or more of the following values:

    Value Description
    FILE_ATTRIBUTE_ARCHIVE The file or directory is an archive file. Applications use this attribute to mark files for backup or removal.
    FILE_ATTRIBUTE_COMPRESSED The file or directory is compressed. For a file, this means that all of the data in the file is compressed. For a directory, this means that compression is the default for newly created files and subdirectories.
    FILE_ATTRIBUTE_DIRECTORY The handle identifies a directory.
    FILE_ATTRIBUTE_ENCRYPTED The file or directory is encrypted. For a file, this means that all of the data streams are encrypted. For a directory, this means that encryption is the default for newly created files and directories.
    FILE_ATTRIBUTE_HIDDEN The file or directory is hidden. It is not included in an ordinary directory listing.
    FILE_ATTRIBUTE_INROM This file is an operating system file stored in ROM. These files are read-only; they cannot be modified.
    FILE_ATTRIBUTE_NORMAL The file has no other attributes. This attribute is valid only if used alone.
    FILE_ATTRIBUTE_READONLY The file or directory is read-only. Applications can read the file but cannot write to it or delete it. In the case of a directory, applications cannot delete it.
    FILE_ATTRIBUTE_REPARSE_POINT The file has an associated reparse point.
    FILE_ATTRIBUTE_ROMMODULE This file is an operating system file stored in ROM, designed to execute in place. In other words, code from this file is executed directly from ROM, rather than being first copied to RAM. The CreateFile function cannot be used to access this file, instead the LoadLibrary and CreateProcess functions must be used.
    FILE_ATTRIBUTE_ROMSTATICREF The DLL module is statically linked to another module in the ROM file system. This prevents the DLL module from being replaced by a RAM version of the DLL.
    FILE_ATTRIBUTE_SPARSE_FILE The file is a sparse file.
    FILE_ATTRIBUTE_SYSTEM The file or directory is part of the operating system or is used exclusively by the operating system.
    FILE_ATTRIBUTE_TEMPORARY The file is being used for temporary storage. File systems attempt to keep all the data in memory for quicker access, rather than flushing the data back to mass storage. A temporary file should be deleted by the application as soon as it is no longer needed.
  • ftCreationTime
    Specifies the time the file was created. If the underlying file system does not support this time member, ftCreationTime is zero.

  • ftLastAccessTime
    Specifies the time the file was last accessed. If the underlying file system does not support this time member, ftLastAccessTime is zero.

  • ftLastWriteTime
    Specifies the last time the file was written to.

  • dwVolumeSerialNumber
    Specifies the serial number of the volume that contains the file.

  • nFileSizeHigh
    Specifies the high-order word of the file size.

  • nFileSizeLow
    Specifies the low-order word of the file size.

  • nNumberOfLinks
    Specifies the number of links to this file. For the FAT file system this member is always 1. For NTFS, it may be more than 1.

  • nFileIndexHigh
    Specifies the high-order word of a unique identifier associated with the file.

  • nFileIndexLow
    Specifies the low-order word of a unique identifier associated with the file. This identifier and the volume serial number uniquely identify a file. This number may change when the system is restarted or when the file is opened. After a process opens a file, the identifier is constant until the file is closed. An application can use this identifier and the volume serial number to determine whether two handles refer to the same file.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 1.0 and later Winbase.h    

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

CreateFile, CreateProcess, LoadLibrary, GetFileInformationByHandle

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.