SHCOLUMNDATA structure (shlobj.h)

Article
03/13/2023

Contains information that identifies a particular file. It is used by IColumnProvider::GetItemData when requesting data for a particular file.

Syntax

typedef struct {
  ULONG dwFlags;
  DWORD dwFileAttributes;
  ULONG dwReserved;
  WCHAR *pwszExt;
  WCHAR wszFile[MAX_PATH];
} SHCOLUMNDATA, *LPSHCOLUMNDATA;

Members

dwFlags

Type: ULONG

Flags used to specify the nature of the request.

SHCDF_UPDATEITEM

The file specified by wszFile is a new file or a file that has changed since the last call to IColumnProvider::GetItemData. Any cached data should be flushed and recalculated. Column handlers that do not cache data, or that display data that is stored separately from the file, can ignore this flag.

dwFileAttributes

Type: DWORD

File attribute flags. It will be one or more of the following values.

FILE_ATTRIBUTE_ARCHIVE

The file or directory is an archive file or directory. 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 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 data streams in the file are encrypted. For a directory, this means that encryption is the default for newly created files and subdirectories.

FILE_ATTRIBUTE_HIDDEN

The file or directory is hidden. It is not included in an ordinary directory listing.

FILE_ATTRIBUTE_NORMAL

The file or directory has no other attributes set. This attribute is valid only if used alone.

FILE_ATTRIBUTE_OFFLINE

The data of the file is not immediately available. This attribute indicates that the file data has been physically moved to offline storage. This attribute is used by Remote Storage, the hierarchical storage management software in Windows 2000. If this attribute is set, the column handler should avoid opening the file because doing so will cause the file to be recalled from offline storage.

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_SPARSE_FILE

The file is a sparse file.

FILE_ATTRIBUTE_SYSTEM

The file or directory is part of, 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 of 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.

dwReserved

Type: ULONG

Reserved. Set to NULL.

pwszExt

Type: WCHAR*

A pointer to a null-terminated Unicode string with a file name extension.

wszFile[MAX_PATH]

Type: WCHAR[MAX_PATH]

A null-terminated Unicode string containing a fully qualified file path.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Header	shlobj.h