Click here to Skip to main content
11,408,708 members (61,472 online)
Click here to Skip to main content

How to drag a virtual file from your app into Windows Explorer

, 13 Sep 2006 CPOL
Rate this:
Please Sign up or sign in to vote.
Shows how to use CFSTR_FILEDESCRIPTOR and CFSTR_FILECONTENTS to perform drag/drop with virtual files

Introduction

I was working on an FTP client application where I needed to support drag/drop with Windows Explorer. Dropping files from Explorer into the client was trivial and didn't cause me too much trouble, but dropping files back into Explorer was not as easy. Using CF_HDROP was ruled out because the source file would not physically exist, as it would have to be downloaded from the FTP server before Explorer can get at it. After playing around with various stuff, I finally hit upon using CFSTR_FILEDESCRIPTOR and CFSTR_FILECONTENTS, which suited my purposes. In this article, I'll demonstrate a simple dialog app that will let you drag non-existent files from your app into Explorer.

Basic Technique

  • Derive a class from COleDataSource
  • Allocate global memory and create data in CFSTR_FILEDESCRIPTOR format, and then use CacheGlobalData on the COleDataSource derived class
  • Override OnRenderFileData in this derived class
  • In the OnRenderFileData override, handle CFSTR_FILECONTENTS, and write directly to the CFSTR_FILECONTENTS

Creating the demo app

Generate a default Dialog based MFC application with Visual Studio 2005 (or an earlier version if you don't have 2005). Use the resource editor to add a List control to the dialog, and associate a DDX control variable with it of type CListCtrl and name it m_fileList. Now add the following code to the OnInitDialog to setup the List control.

BOOL CExplorerDelayDropDlg::OnInitDialog()
{
    CDialog::OnInitDialog();

    . . .       

    AfxOleInit();

    m_fileList.SetExtendedStyle(LVS_EX_FULLROWSELECT);
    m_fileList.InsertColumn(0, _T("File"), LVCFMT_LEFT,75);
    m_fileList.InsertColumn(1, _T("Details"), LVCFMT_LEFT,175);

    for(TCHAR c = _T('A'); c < _T('F'); c++)
    {
        CString text1, text2;
        text1.Format(_T("%c.txt"),c);
        text2.Format(_T("File full of %cs"),c);
        m_fileList.SetItemText(
            m_fileList.InsertItem(c - _T('A'),text1),1,text2);
    }

    return TRUE;  
}

The code merely fills up the List control with some dummy file names. Note how I have made a call to AfxOleInit (you don't need to do this if your app already supports OLE).

Deriving a class from COleDataSource

Since we are using delayed data rendering, we need to derive a class from COleDataSource so that we can override OnRenderFileData (the default version merely returns FALSE). So, the first step is to add a class named CMyOleDataSource (derived from COleDataSource) to the project.

class CMyOleDataSource : public COleDataSource
{
    DECLARE_DYNAMIC(CMyOleDataSource)

Now, we need to add an override for OnRenderFileData as shown below.

BOOL CMyOleDataSource::OnRenderFileData(
    LPFORMATETC lpFormatEtc,CFile* pFile)
{
    // We only need to handle CFSTR_FILECONTENTS
    if(lpFormatEtc->cfFormat == 
        RegisterClipboardFormat(CFSTR_FILECONTENTS))
    {   
        HGLOBAL hGlob = NULL;
        const int buffSize = 512;
        hGlob = GlobalAlloc(GMEM_FIXED, buffSize);
        if(hGlob)
        {
            LPBYTE pBytes = (LPBYTE)GlobalLock(hGlob);          
            if(pBytes)
            {
                // lpFormatEtc->lindex can be used to identify
                // the file that's being copied
                memset(pBytes, (int) m_Files.GetAt(
                    lpFormatEtc->lindex)[0], buffSize);
                pFile->Write(pBytes,buffSize);              
            }
            GlobalUnlock(hGlob);
        }
        GlobalFree(hGlob);
        // Need to return TRUE to indicate success to Explorer
        return TRUE;
    }
    return COleDataSource::OnRenderFileData(
        lpFormatEtc, pFile);
}

Note how in the above code, I create dummy files by filling up 512 bytes with a specific character that identifies the file. In a more real life scenario, you'd have to retrieve a specific file, identified by the lindex parameter, and then retrieve that file from a remote source or perhaps from an archive.

Now, we just need to handle the LVN_BEGINDRAG notification as shown below. You can either use the Properties box to add a handler, or manually add an ON_NOTIFY handler in the dialog class.

void CExplorerDelayDropDlg::OnBeginDrag(NMHDR *pNMHDR, LRESULT *pResult)
{
    UINT uFileCount = m_fileList.GetSelectedCount();    

    // The CFSTR_FILEDESCRIPTOR format expects a 
    // FILEGROUPDESCRIPTOR structure followed by an
    // array of FILEDESCRIPTOR structures, one for
    // each file being dropped
    UINT uBuffSize = sizeof(FILEGROUPDESCRIPTOR) + 
        (uFileCount-1) * sizeof(FILEDESCRIPTOR);
    HGLOBAL hFileDescriptor = GlobalAlloc ( 
        GHND | GMEM_SHARE, uBuffSize );        

    if(hFileDescriptor)
    {
        FILEGROUPDESCRIPTOR* pGroupDescriptor = 
            (FILEGROUPDESCRIPTOR*) GlobalLock ( hFileDescriptor );
        if(pGroupDescriptor)
        {
            // Need a pointer to the FILEDESCRIPTOR array
            FILEDESCRIPTOR* pFileDescriptorArray = 
                (FILEDESCRIPTOR*)((LPBYTE)pGroupDescriptor + sizeof(UINT));
            pGroupDescriptor->cItems = uFileCount;            

            POSITION pos = m_fileList.GetFirstSelectedItemPosition();
            int index = 0;
            m_DataSrc.m_Files.RemoveAll();
            while( NULL != pos )
            {   
                int nSelItem = m_fileList.GetNextSelectedItem( pos );
                ZeroMemory(&pFileDescriptorArray[index], 
                    sizeof(FILEDESCRIPTOR));
                lstrcpy ( pFileDescriptorArray[index].cFileName, 
                    m_fileList.GetItemText( nSelItem, 0 ) );
                m_DataSrc.m_Files.Add(
                    pFileDescriptorArray[index].cFileName);
                pFileDescriptorArray[index].dwFlags = 
                    FD_FILESIZE|FD_ATTRIBUTES;
                pFileDescriptorArray[index].nFileSizeLow = 512;
                pFileDescriptorArray[index].nFileSizeHigh = 0;
                pFileDescriptorArray[index].dwFileAttributes = 
                    FILE_ATTRIBUTE_NORMAL;
                index++;
            }
        }
        else
        {
            GlobalFree ( hFileDescriptor );
        }
    }
    GlobalUnlock ( hFileDescriptor );       

    // For the CFSTR_FILEDESCRIPTOR format, we use
    // CacheGlobalData since we make that data available 
    // immediately
    FORMATETC etcDescriptor = { 
        RegisterClipboardFormat(CFSTR_FILEDESCRIPTOR), 
        NULL, DVASPECT_CONTENT, -1, TYMED_HGLOBAL };
    m_DataSrc.CacheGlobalData ( RegisterClipboardFormat(
        CFSTR_FILEDESCRIPTOR), hFileDescriptor, &etcDescriptor );

    // For CFSTR_FILECONTENTS, we use DelayRenderFileData
    // as this data will have to come from a non-physical
    // device, like an FTP site, an add-on device, or an archive
    FORMATETC etcContents = { 
        RegisterClipboardFormat(CFSTR_FILECONTENTS), 
        NULL, DVASPECT_CONTENT, -1, TYMED_HGLOBAL };
    m_DataSrc.DelayRenderFileData(RegisterClipboardFormat(
        CFSTR_FILECONTENTS), &etcContents);

    DROPEFFECT dwEffect = m_DataSrc.DoDragDrop ( 
        DROPEFFECT_COPY | DROPEFFECT_MOVE );

    // Free memory in case of failure
    if(dwEffect == DROPEFFECT_NONE )
    {
        GlobalFree( hFileDescriptor );
    } 
    *pResult = 0;
}

Conclusion

That's it. Obviously, this just shows the bare techniques. You'd need to write extra code to make the whole process smooth. For example, if you are pulling the file from a remote device, there'd be a delay before the file gets written, in which case, you'd need to show a progress bar, or ensure that your main app does not freeze up entirely. But the basic technique will remain the same.

Reference

For more on Drag/Drop with Explorer, read Mike Dunn's excellent article : How to Implement Drag and Drop Between Your Program and Explorer which explains how to use CF_HDROP to transfer existing files to Explorer.

History

  • Sep/13/2006 - Article first published

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Nish Nishant

United States United States
Nish Nishant is a Software Architect/Consultant based out of Columbus, Ohio. He has over 15 years of software industry experience in various roles including Lead Software Architect, Principal Software Engineer, and Product Manager. Nish is a recipient of the annual Microsoft Visual C++ MVP Award since 2002 (13 consecutive awards as of 2014).

Nish is an industry acknowledged expert in the Microsoft technology stack. He authored
C++/CLI in Action for Manning Publications in 2005, and had previously co-authored
Extending MFC Applications with the .NET Framework for Addison Wesley in 2003. In addition, he has over 140 published technology articles on CodeProject.com and another 250+ blog articles on his
WordPress blog. Nish is vastly experienced in team management, mentoring teams, and directing all stages of software development.

Contact Nish : You can reach Nish on his google email id voidnish.

Website and Blog

Comments and Discussions

 
Questionhi!How get to the destination address? Pinmemberforcj92817-Nov-13 15:53 
Questionhow can I implement this in .Net or C# PinmemberEdgar10527-May-12 9:39 
QuestionConnecting to a real file or delay loading a CF_HDROP PinmemberRick Pingry12-Nov-10 8:50 
AnswerRe: Connecting to a real file or delay loading a CF_HDROP PinmemberRick Pingry17-Nov-10 7:57 
GeneralRe: Connecting to a real file or delay loading a CF_HDROP PinmvpNishant Sivakumar17-Nov-10 8:18 
GeneralMy vote of 5 PinmemberRick Pingry2-Nov-10 10:35 
QuestionWhat can I do if I want to move a folder? PinmemberYu Tist12-May-09 4:26 
AnswerRe: What can I do if I want to move a folder? [modified] Pinmemberjerry_wangjh4-Dec-10 16:48 
GeneralRe: What can I do if I want to move a folder? [modified] PinmemberLester_200812-Aug-12 0:16 
AnswerRe: What can I do if I want to move a folder? PinmemberLester_200811-Aug-12 0:31 
QuestionHow would I do this without MFC? PinmemberNTDLS4-Mar-08 9:09 
GeneralRe: How would I do this without MFC? PinmvpMichael Dunn18-Mar-08 9:49 
QuestionHow do I drag a 4GB file? Pinmembercmumford9-Aug-07 12:05 
AnswerRe: How do I drag a 4GB file? Pinmemberrfalck21-Aug-07 16:40 
GeneralRe: How do I drag a 4GB file? Pinmemberrfalck22-Aug-07 17:41 
GeneralRe: How do I drag a 4GB file? Pinmemberdrichard283017-Sep-07 13:35 
GeneralRe: How do I drag a 4GB file? Pinmemberrfalck17-Sep-07 14:54 
GeneralRe: How do I drag a 4GB file? Pinmembercmumford25-Sep-07 4:51 
GeneralRe: How do I drag a 4GB file? PinmemberBrian Pence27-Sep-07 10:57 
GeneralRe: How do I drag a 4GB file? Pinmembercmumford27-Sep-07 13:24 
GeneralRe: How do I drag a 4GB file? Pinmemberfabioglauser9-Oct-07 14:34 
GeneralRe: How do I drag a 4GB file? Pinmemberdrichard28307-Nov-07 7:17 
QuestionBuild Fails if "Use of MFC" changed to "Static Library" from "Shared DLL" PinmemberRaptorikus19-Jul-07 8:15 
AnswerRe: Build Fails if "Use of MFC" changed to "Static Library" from "Shared DLL" Pinmembercmumford8-Aug-07 11:12 
QuestionWhere was the file dropped? Pinmemberrfalck1-May-07 16:04 
AnswerRe: Where was the file dropped? Pinmembertimothy_russell3-May-07 16:29 
AnswerRe: Where was the file dropped? Pinmembercmumford29-Oct-07 12:57 
QuestionUnable to complie using MSVC Express w PlatformSDK Pinmembercgrusin127-Feb-07 11:30 
GeneralNot enough storage is available to complete this operation. Pinmemberlallous4-Dec-06 4:40 
GeneralRe: Not enough storage is available to complete this operation. Pinmembercmumford8-Aug-07 11:17 
GeneralRe: Not enough storage is available to complete this operation. PinmvpGiorgi Dalakishvili24-Nov-08 22:30 
GeneralThe code's crashing Pinmemberlallous4-Dec-06 3:17 
GeneralRe: The code's crashing Pinmemberrfalck1-May-07 15:59 
GeneralRe: The code's crashing PinmemberXijie Zhang5-Dec-11 17:19 
GeneralRe: The code's crashing Pinmemberpaopao_lin13-Aug-12 21:43 
GeneralAny idea to implement this in C# Pinmemberjohn Pure23-Oct-06 8:28 
GeneralRe: Any idea to implement this in C# PinmemberMeski23-Oct-06 16:31 
GeneralRe: Any idea to implement this in C# Pinmembertimothy_russell3-May-07 16:41 
QuestionDrag to Notepad? PinmemberMichael A. Rusakov26-Sep-06 19:27 
AnswerRe: Drag to Notepad? PinstaffNishant Sivakumar11-Oct-06 7:22 
GeneralRe: Drag to Notepad? PinmemberDavid C Elliott11-Jan-07 6:14 
GeneralVC2003 doesn't open the project PinmemberMichael A. Rusakov26-Sep-06 19:20 
GeneralRe: VC2003 doesn't open the project PinstaffNishant Sivakumar11-Oct-06 7:20 
GeneralRe: VC2003 doesn't open the project Pinmemberindrekm28-Oct-06 4:41 
QuestionWhen it is a big file, does it become an error why? Pinmembergiura21-Sep-06 21:32 
AnswerRe: When it is a big file, does it become an error why? PinstaffNishant Sivakumar11-Oct-06 7:17 
QuestionRe: When it is a big file, does it become an error why? [modified] Pinmembergiura12-Oct-06 22:19 
GeneralHandy PinsitebuilderShog918-Sep-06 8:36 
GeneralRe: Handy PinstaffNishant Sivakumar18-Sep-06 8:49 
GeneralRe: Handy PinsitebuilderShog918-Sep-06 9:10 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web03 | 2.8.150414.5 | Last Updated 13 Sep 2006
Article Copyright 2006 by Nish Nishant
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid