Rename method of the CIM_DataFile class

The Rename method renames the logical file (or directory) that is specified in the object path. A rename is not supported if the destination is on another drive or if overwriting an existing logical file is required. This method 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 Rename(
  [in] string FileName
);

Parameters

FileName [in]

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

Example: "c:\temp\newfile.txt"

Return value

Returns a value of 0 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.

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 Rename 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 2008
Namespace
Root\CIMV2
MOF
CIMWin32.mof
DLL
CIMWin32.dll

See also

CIM_DataFile

CIM_DataFile

WMI Tasks: Files and Folders

File and Directory Access Rights Constants