SHFILEOPSTRUCT
Contains
information that the SHFileOperation
typedef struct _SHFILEOPSTRUCT { // shfos
HWND hwnd;
UINT wFunc;
LPCSTR pFrom;
LPCSTR pTo;
FILEOP_FLAGS fFlags;
BOOL fAnyOperationsAborted;
LPVOID hNameMappings;
LPCSTR lpszProgressTitle;
} SHFILEOPSTRUCT, FAR *LPSHFILEOPSTRUCT;
Members
hwnd
Handle of the
dialog box to use to display information about the status of the operation.
wFunc
Operation to
perform. This member can be one of the following values:
FO_COPY |
Copies the
files specified by pFrom to the location specified by pTo. |
FO_DELETE |
Deletes the
files specified by pFrom (pTo is ignored). |
FO_MOVE |
Moves the
files specified by pFrom to the location specified by pTo. |
FO_RENAME |
Renames the
files specified by pFrom. |
pFrom
Pointer to a
buffer that specifies one or more source file names. Multiple names must be
null-separated. The list of names must be double null-terminated.
pTo
Pointer to a
buffer that contains the name of the destination file or directory. The buffer
can contain mutiple destination file names if the fFlags member
specifies FOF_MULTIDESTFILES. Multiple names must be null-separated. The list
of names must be double null-terminated.
fFlags
Flags that
control the file operation. This member can be a combination of the following
values:
FOF_ALLOWUNDO |
Preserves
undo information, if possible. |
FOF_CONFIRMMOUSE |
Not
implemented. |
FOF_FILESONLY |
Performs
the operation only on files if a wildcard filename (*.*) is specified. |
FOF_MULTIDESTFILES |
Indicates
that the pTo member specifies multiple destination files (one for each
source file) rather than one directory where all source files are to be
deposited. |
FOF_NOCONFIRMATION |
Responds
with yes to all for any dialog box that is displayed. |
FOF_NOCONFIRMMKDIR |
Does not
confirm the creation of a new directory if the operation requires one to be
created. |
FOF_RENAMEONCOLLISION |
Gives the
file being operated on a new name (such as Copy #1 of... ) in a move, copy,
or rename operation if a file of the target name already exists. |
FOF_SILENT |
Does not
display a progress dialog box. |
FOF_SIMPLEPROGRESS |
Displays a
progress dialog box, but does not show the filenames. |
FOF_WANTMAPPINGHANDLE |
Fills in
the hNameMappings member. The handle must be freed by using the SHFreeNameMappings |
fAnyOperationsAborted
Value that
receives TRUE if the user aborted any file operations before they were
completed or FALSE otherwise.
hNameMappings
Handle of a
filename mapping object that contains an array of SHNAMEMAPPING
lpszProgressTitle
Pointer to a
string to use as the title for a progress dialog box. This member is used only
if fFlags includes FOF_SIMPLEPROGRESS.
Remarks
If pFrom
or pTo are unqualified names, the current directories are taken from the
global current drive and directory settings as managed by the GetCurrentDirectory
and SetCurrentDirectory functions.
See Also