CopyEx method of the CIM_LogicalFile class

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

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  StopFileName,
  [in, optional] string  StartFileName,
  [in, optional] 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 is null if the method succeeds.

StartFileName [in, optional]

String that names 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.

Recursive [in, optional]

If TRUE, the method is also applied recursively to files and directories within the directory specified by the CIM_LogicalFile 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.

Success

0

Success.

Access Denied

2

Access denied.

Unspecified failure

8

Unspecified failure.

Invalid object

9

Invalid object.

Object already exists

10

Object already exists.

File system not NTFS

11

File system not NTFS.

Platform not NT/Windows 2000

12

Platform not Windows.

Drive not the same

13

Drive not the same.

Directory not empty

14

Directory not empty.

Sharing violation

15

Sharing violation.

Invalid start file

16

Invalid start file.

Privilege not held

17

Privilege not held.

Invalid parameter

21

Invalid parameter.

Remarks

This method is currently not implemented by WMI. To use this method, you must implement it in your own provider.

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

Requirement Value
Minimum supported client
Windows Vista
Minimum supported server
Windows Server 2008
Namespace
Root\CIMV2
MOF
CIMWin32.mof
DLL
CIMWin32.dll

See also

CIM_LogicalFile

CIM_LogicalFile