Patch by Sylvain Petreolle:
[reactos.git] / rosapps / winfile / format.h
1 #if !defined(SHFMT_OPT_FULL)
2
3 #if defined (__cplusplus)
4 extern "C" {
5 #endif
6
7 /*****************************************************************
8 The SHFormatDrive API provides access to the Shell's format
9 dialog box. This allows applications that want to format disks to bring
10 up the same dialog box that the Shell uses for disk formatting.
11
12 PARAMETERS
13 hWnd = The window handle of the window that will own the
14 dialog. NOTE that hWnd == NULL does not cause this
15 dialog to come up as a "top level application"
16 window. This parameter should always be non-null,
17 this dialog box is only designed to be the child of
18 another window, not a stand-alone application.
19
20 drive = The 0 based (A: == 0) drive number of the drive
21 to format.
22
23 fmtID = Currently must be set to SHFMT_ID_DEFAULT.
24
25 options = There are currently only two option bits defined.
26
27 SHFMT_OPT_FULL
28 SHFMT_OPT_SYSONLY
29
30 SHFMT_OPT_FULL specifies that the "Quick Format"
31 setting should be cleared by default. If the user
32 leaves the "Quick Format" setting cleared, then a
33 full format will be applied (this is useful for
34 users that detect "unformatted" disks and want
35 to bring up the format dialog box).
36
37 If options is set to zero (0), then the "Quick Format"
38 setting is set by default. In addition, if the user leaves
39 it set, a quick format is performed. Under Windows NT 4.0,
40 this flag is ignored and the "Quick Format" box is always
41 checked when the dialog box first appears. The user can
42 still change it. This is by design.
43
44 The SHFMT_OPT_SYSONLY initializes the dialog to
45 default to just sys the disk.
46
47 All other bits are reserved for future expansion
48 and must be 0.
49
50 Please note that this is a bit field and not a
51 value, treat it accordingly.
52
53 RETURN
54 The return is either one of the SHFMT_* values, or if
55 the returned DWORD value is not == to one of these
56 values, then the return is the physical format ID of the
57 last successful format. The LOWORD of this value can be
58 passed on subsequent calls as the fmtID parameter to
59 "format the same type you did last time".
60
61 *****************************************************************/
62 DWORD WINAPI SHFormatDrive(HWND hWnd,
63 UINT drive,
64 UINT fmtID,
65 UINT options);
66
67 //
68 // Special value of fmtID which means "use the defaultformat"
69 //
70
71 #define SHFMT_ID_DEFAULT 0xFFFF
72
73 //
74 // Option bits for options parameter
75 //
76
77 #define SHFMT_OPT_FULL 0x0001
78 #define SHFMT_OPT_SYSONLY 0x0002
79
80 //
81 // Special return values. PLEASE NOTE that these are DWORD values.
82 //
83
84 #define SHFMT_ERROR 0xFFFFFFFFL // Error on last format,
85 // drive may be formatable
86 #define SHFMT_CANCEL 0xFFFFFFFEL // Last format wascanceled
87 #define SHFMT_NOFORMAT 0xFFFFFFFDL // Drive is not formatable
88
89 #if defined (__cplusplus)
90 }
91 #endif
92 #endif
93