Name
RenameFileInGuest
Description
HRESULT
RenameFileInGuest([in] BSTR oldName,
[in] BSTR newName,
[in] LONG options,
[in] IVixHandle* propertyList,
[in] ICallback* jobDoneCallback,
[out,retval] IJob** renameJob);
This function renames a file or directory in the guest operating system.
Parameters
- oldName
-
The path to the file to be renamed.
- newName
-
The path to the new file.
- options
-
Must be 0.
- propertyListHandle
-
Must be NULL (C++), null (C#), or Nothing (VB).
- jobDoneCallback
-
An ICallback instance that will be called when the
operation is complete.
- renameJob
-
Returns an IJob object that describes the state of this asynchronous operation.
Return Value
HRESULT
Remarks
- You must call VM::LoginInGuest() before calling this function.
- Only absolute paths should be used for files in the guest; the resolution of
relative paths is not specified.
Side Effects
None.
Requirements
VixCOM.h, since VMware Workstation 6.0