Click here to Skip to main content
Click here to Skip to main content
Go to top

CFormatDriveDialog - A wrapper class for the undocumented SHFormatDrive API function

, 27 Aug 2002
Rate this:
Please Sign up or sign in to vote.
A wrapper class for SHFormatDrive (XP/2K only). Corrects some errors in KB article Q173688

Overview

This class basically brings up the Windows Disk-Format dialog box. You'd have thought it would have become part of the common dialogs by now. What's worse is that some of the information in KB article Q173688 is now incorrect as far as Windows XP and Windows 2000 are concerned. I presume that the KB article was written during the 9x days and they forgot to remove or update it later. What confused me was that the KB article  states that the information in it applies to XP and 2K. The first shock for me was to discover that the Quick-Format option behaved exactly opposite to how it was described in the KB article. In addition the Make-system-disk option was not even working properly. Anyway I've written a class - CFormatDriveDialog that basically wraps the stuff for you. I have stuck to the MS recommended constant definitions where they work, but in other cases I've either discarded them or added my own.

Strong warning

The information in KB article Q173688 is partially incorrect. Do not follow it blindly if you intend to build on this class. Also note that this class should only be used on Win2K/XP systems. The KB article is to be followed for older OS versions like 9x and ME.

Class Reference

There's just one public method here (of course, in addition to the parameter-less constructor).

DoModal

int CFormatDriveDialog::DoModal(HWND hWnd, UINT Drive, bool bQuickFormat, LPCTSTR vol_label);

  • hWnd - The window handle of the dialog's parent. This cannot be NULL.
  • Drive - The drive code (0 for A, 1 for B, 2 for C etc.) I've defined constants like DRIVEA, DRIVEB, DRIVEC etc. which you may use instead of raw numbers. They are defined in the header file.
  • bQuickFormat - If true then the Quick-Format check box is ticked by default.
  • vol_label - The default value for the volume label to be used.

Return Value

IDOK if a successful format was completed and IDCANCEL if the format operation was cancelled or if some error occurred.

Sample Usage

void Cnish_testDlg::OnBnClickedButton1()
{
    UpdateData(true);
    CFormatDriveDialog dlg;
    int d=dlg.DoModal(AfxGetMainWnd()->m_hWnd,DRIVEA,
        bQuickFormat,m_vollab);
    if(d==IDOK)
        MessageBox("yeah"); 
}

Tech Details

We call the SHFormatDrive function from shell32.dll. I use LoadLibrary and load shell32.dll and then call GetProcAddress to get SHFormatDrive's address. I also use SetWindowsHookEx to set a CBT hook because we need to set the volume label. The hook proc calls EnumChildWindows and when we encounter a child window with "Edit" class, we know this is the volume label edit box, because that's the only edit box in the dialog. Refer the source code for full details. A snipped partial listing is given below with comments not found in the actual source code.

int CFormatDriveDialog::DoModal(...)
{

    //...

    // Function pointer to hold SHFormatDrive
    FMTDRIVEFUNC* pshfd;

    // Load the dll
    HMODULE hMod = LoadLibrary("shell32.dll");

    // Chk for error - just in case
    if(hMod)
    {
        // Assign function pointer
        pshfd = reinterpret_cast<FMTDRIVEFUNC*>
            (GetProcAddress(hMod,"SHFormatDrive"));

        // Set a WH_CBT hook
        m_hHook = SetWindowsHookEx(WH_CBT,CBTProc,
            AfxGetApp()->m_hInstance,AfxGetApp()->m_nThreadID);

        // Call the function via the function pointer
        rv = ((*pshfd)(hWnd,Drive,SHFMT_ID_DEFAULT,Options)==
            SHFMT_FMTSUCCESS) ? IDOK : IDCANCEL;

        // Free the dll
        FreeLibrary(hMod);
    }
    
    //...
}

LRESULT CALLBACK CFormatDriveDialog::CBTProc(...)
{
    if (nCode == HCBT_ACTIVATE )
    { 
        // Get handle of Format dialog
        HWND hWnd = reinterpret_cast<HWND>(wParam);

        // Enumerate all child windows to get 
        // volume label the edit box
        EnumChildWindows(hWnd,EnumChildProc,NULL); 

        // Finished our need for the hook
        UnhookWindowsHookEx(m_hHook);
        CFormatDriveDialog::m_hHook = NULL; 
    }
    return FALSE;
}

BOOL CALLBACK CFormatDriveDialog::EnumChildProc(...)
{ 
    char buff[256];
    GetClassName(hwnd,buff,255);

    // The vol label edit box is the only edit control
    if(strcmp(buff,"Edit")==0)
    {
        SetWindowText(hwnd,m_vol_label);
        return FALSE;
    }
    return TRUE;
}

Conclusion

There are several return codes and option codes mentioned in the above mentioned KB article. But none of them work as expected, and some of them don't work at all. In addition the code constant given for Quick-Format works in the exact opposite manner. Of course I base my results from trying out the code on my own machine which is an XP professional box. I also got James T Johnson to test it partially on his XP professional box and Smitha(Tweety) to test it on her Windows 2000 professional box. But I have no idea how this class will work on untested OS versions with or without service packs.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Nish Sivakumar

United States United States
Nish is a real nice guy who has been writing code since 1990 when he first got his hands on an 8088 with 640 KB RAM. Originally from sunny Trivandrum in India, he has been living in various places over the past few years and often thinks it’s time he settled down somewhere.
 
Nish has been a Microsoft Visual C++ MVP since October, 2002 - awfully nice of Microsoft, he thinks. He maintains an MVP tips and tricks web site - www.voidnish.com where you can find a consolidated list of his articles, writings and ideas on VC++, MFC, .NET and C++/CLI. Oh, and you might want to check out his blog on C++/CLI, MFC, .NET and a lot of other stuff - blog.voidnish.com.
 
Nish loves reading Science Fiction, P G Wodehouse and Agatha Christie, and also fancies himself to be a decent writer of sorts. He has authored a romantic comedy Summer Love and Some more Cricket as well as a programming book – Extending MFC applications with the .NET Framework.
 
Nish's latest book C++/CLI in Action published by Manning Publications is now available for purchase. You can read more about the book on his blog.
 
Despite his wife's attempts to get him into cooking, his best effort so far has been a badly done omelette. Some day, he hopes to be a good cook, and to cook a tasty dinner for his wife.

Comments and Discussions

 
GeneralVista problem PinmemberKranggg22-Oct-09 10:25 
Generala problem Pinmemberqiqi552125-Dec-08 15:45 
Generalhi Pinmemberqiqi552123-Dec-08 17:07 
Generalthe bigger the disk space , the greater the effect. Pinmemberqiqi552123-Dec-08 19:15 
GeneralUmounting the drive Pinmemberjoelparker2-Apr-04 6:45 
Generalformat disk without dialog Pinmemberpoganka24-Jan-04 21:20 
GeneralRe: format disk without dialog Pinmemberzbilal12-Mar-04 12:00 
GeneralRe: format disk without dialog ( How can I do .. ) Pinmemberka.kevinliu29-Mar-07 20:09 
GeneralRe: format disk without dialog ( How can I do .. ) PinmemberGeorge Grimes6-Apr-07 18:22 
GeneralDialog Pinmemberjlechem14-May-03 6:05 
GeneralNot a graphic interface and Hi Rating!!! Great!!! PinmemberGabriel 229-Aug-02 9:29 
Have you noticed people are usually attracted by nice colored interfaces?
Generally, articles based in beautiful interfaces uses to get the highest ratings.
If you post a source code which solves the problem of universal data compression or encryption, you won't probably get a high rating, unless you include a nice colored and animated progress bar.
Your code doesn't provide a super interface, but received high rating. That's good!!! Smile | :)

GeneralRe: Not a graphic interface and Hi Rating!!! Great!!! PineditorNishant S29-Aug-02 14:03 
GeneralVery good article PinmemberMatt Newman29-Aug-02 4:05 
GeneralRe: Very good article PineditorNishant S29-Aug-02 14:03 
GeneralGood work PinmemberKannan Kalyanaraman28-Aug-02 20:38 
GeneralRe: Good work PineditorNishant S28-Aug-02 20:45 
GeneralIt Is Documented PinmemberBlake Coverett28-Aug-02 12:27 
GeneralRe: It Is Documented PineditorNishant S28-Aug-02 12:34 
GeneralRe: It Is Documented #2 PineditorNishant S28-Aug-02 12:38 
QuestionCan you PinmemberChris Losinger28-Aug-02 6:11 
AnswerRe: Can you PinmemberJörgen Sigvardsson28-Aug-02 7:25 
GeneralRe: Can you PinmemberChris Losinger28-Aug-02 7:38 
AnswerRe: Can you PineditorNishant S28-Aug-02 11:51 
GeneralRe: Can you PinmemberChris Losinger28-Aug-02 11:49 
GeneralRe: Can you PinsussAnonymous29-Aug-02 20:02 

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 | Mobile
Web02 | 2.8.140922.1 | Last Updated 28 Aug 2002
Article Copyright 2002 by Nish Sivakumar
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid