{"id":44833,"date":"2015-01-26T07:00:00","date_gmt":"2015-01-26T22:00:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/oldnewthing\/2015\/01\/26\/customizing-item-enumeration-with-ishellitem\/"},"modified":"2019-03-13T12:12:21","modified_gmt":"2019-03-13T19:12:21","slug":"20150126-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20150126-00\/?p=44833","title":{"rendered":"Customizing item enumeration with IShellItem"},"content":{"rendered":"

If you are using the original IShell­Folder<\/code> interface, then you can use SHCONTF<\/code> values to customize how child items are enumerated<\/a>. But what if you’re using IShell­Item<\/code>? <\/p>\n

Let’s take it one step at a time. First, the basic program. (Remember, Little Programs do little to no error checking.) <\/p>\n

\n#define UNICODE\n#define _UNICODE<\/a>\n#define STRICT\n#define STRICT_TYPED_ITEMIDS<\/a>\n#include <windows.h>\n#include <shlobj.h>\n#include <atlbase.h>\n#include <atlalloc.h>\n#include <propsys.h>\n#include <stdio.h>\n\nint __cdecl wmain(int argc, wchar_t **argv)\n{\n CCoInitialize<\/a> init;\n\n if (argc < 2) return 0;\n CComPtr<IShellItem> spsiFolder;\n SHCreateItemFromParsingName(argv[1], nullptr,\n                             IID_PPV_ARGS(&spsiFolder));\n\n CComPtr<IEnumShellItems> spesi;\n spsiFolder->BindToHandler(nullptr, BHID_EnumItems,\n                              IID_PPV_ARGS(&spesi));\n\n for (CComPtr<IShellItem> spsi;\n      spesi->Next(1, &spsi, nullptr) == S_OK;\n      spsi.Release()) {\n  PrintDisplayName<\/a>(spsi, SIGDN_NORMALDISPLAY, L\"Display Name\");\n  PrintDisplayName(spsi, SIGDN_FILESYSPATH, L\"File system path\");\n  wprintf(L\"\\n\");\n }\n return 0;\n}\n<\/pre>\n
Run this program with the fully-qualified path to a directory as the command line argument, and it enumerates all the items in the folder. This uses the default enumeration, which is “include both folders and non-folders, and include hidden items, but not super-hidden items.” <\/p>\n
But what if we want to customize the enumeration? <\/p>\n
We saw that the IBindCtx<\/code> parameter acts as a catch-all options<\/i> parameter<\/a>. In this case, we need to look at the options available for BHID_Enum­Items<\/code> and see if any of them help us. <\/p>\n
Fortunately, we have STR_ENUM_ITEMS_FLAGS<\/code> which lets us override the default enumeration mode. Let’s say that we want only folders, and we want to respect the user’s preferences for hidden items (which means that we omit SHCONTF_HIDDEN<\/code>). <\/p>\n
I’m goint to do this two ways. First the flat version: <\/p>\n
\n ...\n CComPtr<IBindCtx> spbcEnum;\n CreateDwordBindCtx<\/a>(STR_ENUM_ITEMS_FLAGS, SHCONTF_FOLDERS,\n                    &spbcEnum);<\/font>\n\n CComPtr<IEnumShellItems> spesi;\n spsiFolder->BindToHandler(spbcEnum<\/font>, BHID_EnumItems,\n                              IID_PPV_ARGS(&spesi));\n<\/pre>\n
Now the fluent version: <\/p>\n
\n ...\n CBindCtxBuilder<\/a> builder;\n builder.SetVariantDword(STR_ENUM_ITEMS_FLAGS, SHCONTF_FOLDERS);<\/font>\n\n CComPtr<IEnumShellItems> spesi;\n spsiFolder->BindToHandler(builder.GetBindCtx()<\/font>, BHID_EnumItems,\n                              IID_PPV_ARGS(&spesi));\n<\/pre>\n
(Don’t forget that error checking has been elided for expository purposes.) <\/p>\n
The STR_ENUM_ITEMS_FLAGS<\/code> bind context string was added in Windows 8, so it has no effect on older versions of Windows. We’ll address this next week. <\/p>\n
Note that the IEnum­Shell­Items<\/code> interface is incorrectly-named. The convention for enumeration interfaces is to name them IEnum­XXX<\/code>, where XXX is singular<\/i>. <\/p>\n","protected":false},"excerpt":{"rendered":"
Have it your way.<\/p>\n","protected":false},"author":1069,"featured_media":111744,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[25],"class_list":["post-44833","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
Have it your way.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/44833","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/users\/1069"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/comments?post=44833"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/44833\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media\/111744"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media?parent=44833"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=44833"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=44833"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}