Tag Archives: CFileDialog

File Open Dialog with Multiple Selection – Part 3: Cutting the Dog Tail

First two articles in this series show how to deal with a large number of selected items, by manipulating the OPENFILENAME::lpstrFile buffer, either for old style or Vista-style Open File dialogs. However, if the target system is Windows Vista or newer, we should prefer getting rid of old stuff and use only Vista-style dialogs.
So, let’s cut the dog’s tail as fast and painless as possible!

Using IFileOpenDialog to collect the results

Example 5

void CWhateverClass::OnFileOpen()
{
   CFileDialog dlgOpenFile(TRUE);
   dlgOpenFile.GetOFN().Flags |= OFN_ALLOWMULTISELECT;

   if(IDOK == dlgOpenFile.DoModal())
   {
      IFileOpenDialog* pIFileOpenDialog = dlgOpenFile.GetIFileOpenDialog();
      ASSERT(NULL != pIFileOpenDialog);

      CComPtr<IShellItemArray> pIShellItemArray;
      HRESULT hr = pIFileOpenDialog->GetResults(&pIShellItemArray); 
      if(SUCCEEDED(hr))
      {
         DWORD dwItemCount = 0;
         hr = pIShellItemArray->GetCount(&dwItemCount);
         ASSERT(SUCCEEDED(hr));
         for(DWORD dwItem = 0; dwItem < dwItemCount; dwItem++)          
         {
            CComPtr<IShellItem> pIShellItem;
            pIShellItemArray->GetItemAt(dwItem, &pIShellItem);

            LPWSTR pszFilePath = NULL;
            hr = pIShellItem->GetDisplayName(SIGDN_FILESYSPATH, &pszFilePath);
            if(SUCCEEDED(hr))
            {
               CString strFilePath(pszFilePath);
               // ...do something with strFilePath...
               ::CoTaskMemFree(pszFilePath);
            }
         }
      }
      pIFileOpenDialog->Release(); // release IFileOpenDialog
   }
}

void CWhateverClass::OnFileOpen()

{

CFileDialog dlgOpenFile(TRUE);

dlgOpenFile.GetOFN().Flags |= OFN_ALLOWMULTISELECT;

if(IDOK == dlgOpenFile.DoModal())

{

IFileOpenDialog* pIFileOpenDialog = dlgOpenFile.GetIFileOpenDialog();

ASSERT(NULL != pIFileOpenDialog);

CComPtr<IShellItemArray> pIShellItemArray;

HRESULT hr = pIFileOpenDialog->GetResults(&pIShellItemArray);

if(SUCCEEDED(hr))

{

DWORD dwItemCount = 0;

hr = pIShellItemArray->GetCount(&dwItemCount);

ASSERT(SUCCEEDED(hr));

for(DWORD dwItem = 0; dwItem < dwItemCount; dwItem++)

{

CComPtr<IShellItem> pIShellItem;

pIShellItemArray->GetItemAt(dwItem, &pIShellItem);

LPWSTR pszFilePath = NULL;

hr = pIShellItem->GetDisplayName(SIGDN_FILESYSPATH, &pszFilePath);

if(SUCCEEDED(hr))

{

CString strFilePath(pszFilePath);

// ...do something with strFilePath...

::CoTaskMemFree(pszFilePath);

}

pIFileOpenDialog->Release(); // release IFileOpenDialog

}

This time, we’ve used Common Item Dialog API (IFileOpenDialog interface and so on) instead of the “classic” CFileDialog::GetStartPosition and CFileDialog::GetNextPathName. That allows to step beyond the old stuff limits without overriding any CFileDialog method and without doing any other type of “dancing on the rope”.

Demo application

Vista File Open Dialog with Multiple Selection – Demo

The demo application demonstrates how to grab File Open dialog results by using Common Item Dialog API. For demo/testing purpose it has also a function which uses the old way of CFileDialog::GetNextPathName. Just uncheck “Use IFileOpenDialog”, push “Open…” button, select a large number of items from the open file dialog list, then see the difference.

Demo project download: Vista File Open Dialog with Multiple Selection (1275)

Notes

Common Item Dialog API is supported on Windows Vista and newer.
CFileDialog with Vista style is implemented in Visual Studio 2008 and newer.
Of course may be also other solutions. For example, someone still would prefer to derive from CFileDialog in order to put all COM stuff in a single place, for making others’ life easier.
For any constructive remark or alternative solution(s), please do not hesitate and leave a comment!

Resources

MSDN and Windows Dev Center (see the links in the previous articles).

File Open Dialog with Multiple Selection – Part 2: Vista Style

Leave a reply

As told in the previous article, if the Open File dialog has Vista style, it’s not possible to use common dialog box messages like CDM_GETFOLDERPATH and CDM_GETSPEC in order to calculate the necessary buffer size, for multiple selection.
Instead, we can use Common Item Dialog API, in our case IFileOpenDialog interface.

Using IFileOpenDialog interface

Here are the main steps:

call CFileDialog::GetIFileOpenDialog to get ponter to IFileOpenDialog interface;
use IFileOpenDialog::GetSelectedItems; it gets a IShellItemArray* containing currently selected items (an array of IShellItem* elements);
for each item call IShellItem::GetDisplayName; use the name length in order to calculate the necessary buffer size.

Example 4

DWORD CMultiFileOpenDialog::_CalcRequiredBuffSizeVistaStyle()
{
   DWORD dwRet = 0;
   IFileOpenDialog* pFileOpen = GetIFileOpenDialog(); 
   ASSERT(NULL != pFileOpen);

   CComPtr<IShellItemArray> pIItemArray;
   HRESULT hr = pFileOpen->GetSelectedItems(&pIItemArray);
   DWORD dwItemCount = 0;
   if(SUCCEEDED(hr))
   {
      hr = pIItemArray->GetCount(&dwItemCount);
      if(SUCCEEDED(hr))
      {
         for(DWORD dwItem = 0; dwItem < dwItemCount; dwItem++)
         {
            CComPtr<IShellItem> pItem;
            hr = pIItemArray->GetItemAt(dwItem, &pItem);
            if(SUCCEEDED(hr))
            {
               LPWSTR pszName = NULL;
               if(dwItem == 0)
               {
                  // get full path and file name
                  hr = pItem->GetDisplayName(SIGDN_FILESYSPATH, &pszName);
               }
               else
               {
                  // get file name
                  hr = pItem->GetDisplayName(SIGDN_NORMALDISPLAY, &pszName);
               }
               if(SUCCEEDED(hr))
               {
                  dwRet += wcslen(pszName) + 1;
                  ::CoTaskMemFree(pszName);
               }
            }
         }
      }
   }
   dwRet += 1; // add an extra character
   // release the IFileOpenDialog pointer
   pFileOpen->Release();
   return dwRet;
}

DWORD CMultiFileOpenDialog::_CalcRequiredBuffSizeVistaStyle()

{

DWORD dwRet = 0;

IFileOpenDialog* pFileOpen = GetIFileOpenDialog();

ASSERT(NULL != pFileOpen);

CComPtr<IShellItemArray> pIItemArray;

HRESULT hr = pFileOpen->GetSelectedItems(&pIItemArray);

DWORD dwItemCount = 0;

if(SUCCEEDED(hr))

{

hr = pIItemArray->GetCount(&dwItemCount);

if(SUCCEEDED(hr))

{

for(DWORD dwItem = 0; dwItem < dwItemCount; dwItem++)

{

CComPtr<IShellItem> pItem;

hr = pIItemArray->GetItemAt(dwItem, &pItem);

if(SUCCEEDED(hr))

{

LPWSTR pszName = NULL;

if(dwItem == 0)

{

// get full path and file name

hr = pItem->GetDisplayName(SIGDN_FILESYSPATH, &pszName);

}

else

{

// get file name

hr = pItem->GetDisplayName(SIGDN_NORMALDISPLAY, &pszName);

}

if(SUCCEEDED(hr))

{

dwRet += wcslen(pszName) + 1;

::CoTaskMemFree(pszName);

}

dwRet += 1; // add an extra character

// release the IFileOpenDialog pointer

pFileOpen->Release();

return dwRet;

}

Further, we can use the returned value to set the OPENFILENAME buffer, if necessary, in CFileDialog::OnFileNameChange overridden function (see the previous article).
Anyway, more implementation details can be found in the attached demo application.

Demo application

File Open Dialog with Multiple Selection – Demo Application

The demo application contains the complete implementation of a CFileDialog-derived class, that fixes the multiple selection issues described in this article. It can be used either for Vista or old style file dialogs. Also, to see what happens if use the default buffer, just uncheck “Use ext. buffer” then push “Open…” and finally, select a large number of items from the open file dialog list.

Demo project download: File Open Dialog with Multiple Selection (1510)

Notes

Common Item Dialog API is supported on Windows Vista and newer.
CFileDialog with Vista style is implemented in Visual Studio 2008 and newer.

Resources

MSDN: CFileDialog::GetIFileOpenDialog
Windows Dev Center: Common Item Dialog
Windows Dev Center: IFileOpenDialog::GetSelectedItems
Windows Dev Center: IShellItem::GetDisplayName

File Open Dialog with Multiple Selection – Part 1: Old Style

Leave a reply

One common beginner’s mistake

Someone may use the following code to show a File Open dialog:

Example 1

   CFileDialog dlgOpenFile(TRUE);
   dlgOpenFile.GetOFN().Flags |= OFN_ALLOWMULTISELECT;
   if(IDOK == dlgOpenFile.DoModal())
   {
      // get selected files
      POSITION pos = dlgOpenFile.GetStartPosition();
      while(NULL != pos)
      {
         CString strFilePath = dlgOpenFile.GetNextPathName(pos);
         // ... do something with strFilePath.
      }
   }

CFileDialog dlgOpenFile(TRUE);

dlgOpenFile.GetOFN().Flags |= OFN_ALLOWMULTISELECT;

if(IDOK == dlgOpenFile.DoModal())

{

// get selected files

POSITION pos = dlgOpenFile.GetStartPosition();

while(NULL != pos)

{

CString strFilePath = dlgOpenFile.GetNextPathName(pos);

// ... do something with strFilePath.

}

Setting OFN_ALLOWMULTISELECT flag tells to Open File dialog to allow multiple file selection. That works fine as log as the user selects a pretty small number of files. Otherwise, it fails with no warning and no file name (or even worse, some garbage) is retrieved.

What is the cause?

If the first parameter of constructor is TRUE, CFileDialog uses GetOpenFileName Windows API function that takes an OPENFILENAME structure. No matter if multiple selection is set, it retrieves all selected (full path and) file names in one single bufffer, which is poited by lpstrFile member of OPENFILENAME. By default, the size of that buffer is set to MAX_PATH (about 260) characters which is pretty small.

Setting a large enough buffer before DoModal

One solution is to make pstrFile member of OPENFILENAME to point to a large enough buffer, able to keep much more file names. Also, the nMaxFile structure member must be set to actual extended buffer size (in characters).

Example 2

   CFileDialog dlgOpenFile(TRUE);
   // add OFN_ALLOWMULTISELECT flag
   dlgOpenFile.GetOFN().Flags |= OFN_ALLOWMULTISELECT;

   try
   {
      // set a buffer to keep at least 100 full path and file names
      const int nBufferSize = 100 * (MAX_PATH + 1) + 1;
      CString strBuffer;
      LPTSTR pBuffer = strBuffer.GetBufferSetLength(nBufferSize);
      dlgOpenFile.GetOFN().lpstrFile = pBuffer;
      dlgOpenFile.GetOFN().nMaxFile = nBufferSize;

      // show modal Open File dialog
      if(IDOK == dlgOpenFile.DoModal())
      {
         // get selected files
         POSITION pos = dlgOpenFile.GetStartPosition();
         while(NULL != pos)
         {
            CString strFilePath = dlgOpenFile.GetNextPathName(pos);
            // ... do something with strFilePath.
         }
      }
      // release buffer
      strBuffer.ReleaseBuffer();
   }
   catch(CException* e)
   {
      e->ReportError();
      e->Delete();
   }

CFileDialog dlgOpenFile(TRUE);

// add OFN_ALLOWMULTISELECT flag

dlgOpenFile.GetOFN().Flags |= OFN_ALLOWMULTISELECT;

try

{

// set a buffer to keep at least 100 full path and file names

const int nBufferSize = 100 * (MAX_PATH + 1) + 1;

CString strBuffer;

LPTSTR pBuffer = strBuffer.GetBufferSetLength(nBufferSize);

dlgOpenFile.GetOFN().lpstrFile = pBuffer;

dlgOpenFile.GetOFN().nMaxFile = nBufferSize;

// show modal Open File dialog

if(IDOK == dlgOpenFile.DoModal())

{

// get selected files

POSITION pos = dlgOpenFile.GetStartPosition();

while(NULL != pos)

{

CString strFilePath = dlgOpenFile.GetNextPathName(pos);

// ... do something with strFilePath.

}

// release buffer

strBuffer.ReleaseBuffer();

}

catch(CException* e)

{

e->ReportError();

e->Delete();

}

It works but is not very ellegant because uses a fixed buffer. Next, well show a method which dynamically estimates and allocate the necessary buffer.

Overriding CFileDialog::OnFileNameChange

CFileDialog::OnFileNameChange is a virtual function that is called as a response to CDN_SELCHANGE notification, sent when the user changes the selection. We can override that function in our own CFileDialog-derived class, then send CDM_GETFOLDERPATH and CDM_GETSPEC mesages in order to estimate the required buffer size.

Example 3

class CMyFileDialog : public CFileDialog
{
// Attributes
private:
   LPTSTR m_pFileBuff;
// ...
// Overrides
protected:
   virtual void OnFileNameChange();
// ...
};

class CMyFileDialog : public CFileDialog

{

// Attributes

private:

LPTSTR m_pFileBuff;

// ...

// Overrides

protected:

virtual void OnFileNameChange();

// ...

};

void CMyFileDialog::OnFileNameChange()
{  
   ASSERT(GetOFN().Flags & OFN_EXPLORER);
   CWnd* pParent = GetParent();
   ASSERT(NULL != pParent);

   // get required sizes for path and file names buffers
   const UINT nPathSize = (UINT)pParent->SendMessage(CDM_GETFOLDERPATH);
   const UINT nFileSize = (UINT)pParent->SendMessage(CDM_GETSPEC);
   const UINT nMaxFile = GetOFN().nMaxFile;

   if(nPathSize + nFileSize > nMaxFile)
   {
      delete []m_pFileBuff;
      m_pFileBuff = new TCHAR[nPathSize + nFileSize + 1];
      // set new buffer
      GetOFN().lpstrFile = m_pFileBuff;
      GetOFN().nMaxFile = nPathSize + nFileSize + 1;
   }

   CFileDialog::OnFileNameChange();
}

void CMyFileDialog::OnFileNameChange()

{

ASSERT(GetOFN().Flags & OFN_EXPLORER);

CWnd* pParent = GetParent();

ASSERT(NULL != pParent);

// get required sizes for path and file names buffers

const UINT nPathSize = (UINT)pParent->SendMessage(CDM_GETFOLDERPATH);

const UINT nFileSize = (UINT)pParent->SendMessage(CDM_GETSPEC);

const UINT nMaxFile = GetOFN().nMaxFile;

if(nPathSize + nFileSize > nMaxFile)

{

delete []m_pFileBuff;

m_pFileBuff = new TCHAR[nPathSize + nFileSize + 1];

// set new buffer

GetOFN().lpstrFile = m_pFileBuff;

GetOFN().nMaxFile = nPathSize + nFileSize + 1;

}

CFileDialog::OnFileNameChange();

}

Pretty nice but it works only if CFileDialog has not Vista style. I’ll show how to resolve this, in the next article.

Resources

MSDN: CFileDialog Class
MSDN: CFileDialog::OnFileNameChange
Windows Dev Center: Common Dialog Box Messages

MFC-extension WIC File Dialogs

Leave a reply

A previous article showed how to enumerate WIC (Windows Imaging Component) codecs, that are available in system.
Now, let’s use the codecs list in order to make File Open and File Save As dialogs which are dealing with WIC-compliant image files, i.e. having “File of type” filter list according to available WIC codecs (see the images, below).

WIC Open File Dialog

WIC Save As File Dialog

CWICFileDialog class

CWICFileDialog is derived from CFileDialog MFC class. It basically overrides CFileDialog::DoModal and constructs the file types filter.

INT_PTR CWICFileDialog::DoModal()
{
   // Get a list of available decoders or encoders 
   // for File Open or File Save As dialog, respectively
   WICComponentType type = m_bOpenFileDialog ? WICDecoder : WICEncoder;
   CodecsInfoList list;
   VERIFY(SUCCEEDED(_FillCodecsInfoList(type, list)));

   // Constructs MFC-style filter (using '|' as separator.
   _ConstructMFCStyleFilter(list);

   // translate MFC-style filter into WinAPI-style filter (using '\0' as separator). 
   _TranslateFilter();

   // clear the codecs info list
   _ClearCodecsInfoList(list);

   // call base class method
   return CFileDialog::DoModal();
}

INT_PTR CWICFileDialog::DoModal()

{

// Get a list of available decoders or encoders

// for File Open or File Save As dialog, respectively

WICComponentType type = m_bOpenFileDialog ? WICDecoder : WICEncoder;

CodecsInfoList list;

VERIFY(SUCCEEDED(_FillCodecsInfoList(type, list)));

// Constructs MFC-style filter (using '|' as separator.

_ConstructMFCStyleFilter(list);

// translate MFC-style filter into WinAPI-style filter (using '\0' as separator).

_TranslateFilter();

// clear the codecs info list

_ClearCodecsInfoList(list);

// call base class method

return CFileDialog::DoModal();

}

For implementation details, download the demo project attached here.

Demo project

The demo project is just a simple dialog-based MFC application that uses CWICFileDialog. It does nothing else but only shows the file dialogs.
Of course, in practice, you can use CWICFileDialog class in more complex applications like image file viewers, image file converters, and so on.

Resources

MSDN Library: CFileDialog Class
Windows Dev Center: Windows Imaging Component

Downloads

WIC File Dialogs - Demo Project (1512)

codexpert blog

I see native code

Tag Archives: CFileDialog

File Open Dialog with Multiple Selection – Part 3: Cutting the Dog Tail

Using IFileOpenDialog to collect the results

Demo application

Notes

Resources

See also

Like this:

File Open Dialog with Multiple Selection – Part 2: Vista Style

Using IFileOpenDialog interface

Demo application

Notes

Resources

See also

Like this:

File Open Dialog with Multiple Selection – Part 1: Old Style

One common beginner’s mistake

What is the cause?

Setting a large enough buffer before DoModal

Overriding CFileDialog::OnFileNameChange

Resources

See also

Like this:

MFC-extension WIC File Dialogs

CWICFileDialog class

Demo project

Resources

See also

Downloads

Like this:

Using IFileOpenDialog to collect the results

Demo application

Notes

Resources

See also

Share this:

Like this:

Using IFileOpenDialog interface

Demo application

Notes

Resources

See also

Share this:

Like this:

One common beginner’s mistake

What is the cause?

Setting a large enough buffer before DoModal

Overriding CFileDialog::OnFileNameChange

Resources

See also

Share this:

Like this:

CWICFileDialog class

Demo project

Resources

See also

Downloads

Share this:

Like this: