Tuning SHGetFileInfo for Optimum Performance

If you're writing programs to interface with the Windows Shell, chances are you'll eventually want to use the SHGetFileInfo function. This function "retrieves information about an object in the file system, such as a file, a folder, a directory, or a drive root". However, this information may come at a heavy price.

Recently, I wrote an Explorer style "Open file" dialog that used a CListCtrl. The CListCtrl was populated by enumerating the Windows Shell for a specified directory. I needed to retrieve the icon and the type name for each shell object. The dialog performed fine until I enumerated a directory with several thousand files. The total time required to fill the control ranged from 20-40 seconds. The code I used included the following snippet:

//  get the shell object info.
SHGetFileInfo(path,
              0,
              &sfi,
              sizeof(SHFILEINFO), 
              SHGFI_ICON | SHGFI_TYPENAME);

After using the Microsoft Profiler (within the development environment), it was obvious that a good majority of the time was spent executing the SHGetFileInfo command. A command I thought would execute fairly quickly. What I discovered is that using the above format of the command forced the program to access each file in the enumeration to obtain the requested information. This can be a performance hit when you're accessing several thousand files over a network. Microsoft's documentation does not clearly explain this.

The resolution to my problem came about after much research and reading of Dino Esposito's Visual C++ Windows Shell Programming. I needed a way of obtaining the required information WITHOUT accessing every file in the enumeration. The resolution required the following change to my code:

//  get attributes of the shell object using its pidl.
psfFolder->GetAttributesOf(1, (LPCITEMIDLIST*)&pIDL, &dwFileAttr);

//  set the SHGetFileInfo attribute based on the type
//  of shell object.  We'll use this to force the
//  SHGetFileInfo call to NOT access the shell object.
//  (all we want is the icon & type name; the 
//  combination of the SHGFI_USEFILEATTRIBUTES flag
//  and the FILE_ attribute will prevent any unnecessary
//  access of the shell object).
if ((dwFileAttr & SFGAO_FOLDER) == SFGAO_FOLDER)
 attr = FILE_ATTRIBUTE_DIRECTORY;
else
 attr = FILE_ATTRIBUTE_NORMAL;

//  get the shell object info.
SHGetFileInfo(path,
              attr,
              &sfi,
              sizeof(SHFILEINFO), 
              SHGFI_USEFILEATTRIBUTES | SHGFI_ICON | SHGFI_TYPENAME);

By setting the attr variable to a valid FILE_ flag and adding the SHGFI_USEFILEATTRIBUTES flag, I was able to avoid accessing each file in the enumeration. By setting the SHGFI_USEFILEATTRIBUTES flag, I forced the function to assume that the file passed in through the "path" variable exists. An undocumented feature allows the function to use the extension and search the registry for information about the icon and the type name. This simple change reduced my total access time to 5-6 seconds. Although not up to par with Explorer, it's a change I can live with.



Comments

  • It works fine

    Posted by Legacy on 06/01/2001 12:00am

    Originally posted by: Yarp

    I had just noticed this problem on my File Explorer. The tuning works fine.
    Thanks a lot

    Reply
Leave a Comment
  • Your email address will not be published. All fields are required.

Top White Papers and Webcasts

  • As virtualization becomes the norm throughout organizations of nearly all sizes, and as more organizations look to private cloud solutions, IT decision makers are increasingly in need of ways to keep storage costs and complexity under control in the face of often-runaway virtual machine (VM) sprawl. Application-aware storage is designed to help achieve these important goals. Read this white paper to learn how application-aware storage allows you to gain VM-level visibility into application performance and …

  • On-demand Event Event Date: March 19, 2015 The 2015 Enterprise Mobile Application Survey asked 250 mobility professionals what their biggest mobile challenges are, how many employees they are equipping with mobile apps, and their methods for driving value with mobility. Join Dan Woods, Editor and CTO of CITO Research, and Alan Murray, SVP of Products at Apperian, as they break down the results of this survey and discuss how enterprises are using mobile application management and private app stores to …

Most Popular Programming Stories

More for Developers

RSS Feeds

Thanks for your registration, follow us on our social networks to keep up-to-date