CopyEx method of the Win32_Directory class
The CopyEx WMI class method copies the logical directory entry file or directory specified in the object path to the location specified by the FileName parameter. This method is an extended version of the Copy method. A copy is not supported if overwriting an existing logical file is required.
This topic uses Managed Object Format (MOF) syntax. For more information about using this method, see Calling a Method.
Syntax
uint32 CopyEx(
[in] string FileName,
[out] string StopFileName,
[in, optional] string StartFileName,
[in, optional] boolean Recursive
);
Parameters
-
FileName [in]
-
Fully qualified name of the copy of the file (or directory). Example: c:\temp\newdirectory.
-
StopFileName [out]
-
Name of the file or directory where the CopyEx method failed. This parameter will be null if the method succeeds.
-
StartFileName [in, optional]
-
Names the child file or directory to use as a starting point for CopyEx. The StartFileName parameter is typically the StopFileName parameter specifying the file or directory at which an error occurred from the previous method call. If this parameter is NULL, the operation is performed on the file or directory specified in the ExecMethod call.
If StartFileName is used, Recursive must be set to true as well.
-
Recursive [in, optional]
-
If true, files and directories will be copied recursively within the directory specified by the CIM_LogicalFile instance.
Note
For file instances, the Recursive input parameter is ignored.
Return value
Returns a value of 0 (zero) if the file was successfully copied, and any other number to indicate an error.
-
0
-
The request was successful.
-
2
-
Access was denied.
-
8
-
An unspecified failure occurred.
-
9
-
The name specified was not valid.
-
10
-
The object specified already exists.
-
11
-
The file system is not NTFS.
-
12
-
The platform is not Windows.
-
13
-
The drive is not the same.
-
14
-
The directory is not empty.
-
15
-
There has been a sharing violation.
-
16
-
The start file specified was not valid.
-
17
-
A privilege required for the operation is not held.
-
21
-
A parameter specified is not valid.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows Vista |
| Minimum supported server |
Windows Server 2008 |
| Namespace |
Root\CIMV2 |
| MOF |
|
| DLL |
|