Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

CopyEx method of the CIM_DataFile class

The CopyEx method copies the logical file (or directory) that is specified in the object path to the location specified by the FileName parameter. A copy is not supported if it requires overwriting an existing logical file. This method is an extended version of the Copy method and is inherited from CIM_LogicalFile.

Important  The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

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 REF StopFileName,
  [in]   string StartFileName,
  [in]   boolean Recursive
);

Parameters

FileName [in]

Fully qualified name of the destination file (or directory).

Example: "c:\temp\newdirectory"

StopFileName [out]

String that represents the name of the file (or directory) where the method failed. This parameter will be null if the method succeeds.

StartFileName [in]

String that represents the child file (or directory) to use as a starting point for this method. Typically, the StartFileName parameter is 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]

If TRUE, the method is also applied recursively to files and directories within the directory specified by the CIM_DataFile instance. For file instances, this parameter is ignored.

Return value

Returns a value of 0 (zero) on success, and any other number to indicate an error. For additional error codes, see WMI Error Constants or WbemErrorEnum. For general HRESULT values, see System Error Codes.

Return valueDescription
0

Success.

2

Access denied.

8

Unspecified failure.

9

Invalid object.

10

Object already exists.

11

File system not NTFS.

12

Platform not Windows.

13

Drive not the same.

14

Directory not empty.

15

Sharing violation.

16

Invalid start file.

17

Privilege not held.

21

Invalid parameter.

 

Remarks

The CopyEx method in CIM_DataFile is implemented by WMI.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003

Namespace

\root\CIMV2

MOF

CIMWin32.mof

DLL

CIMWin32.dll

See also

CIM_DataFile
WMI Tasks: Files and Folders
File and Directory Access Rights Constants

 

 

Show:
© 2014 Microsoft