Name

Description

$err = VMRenameFileInGuest($vmHandle,
                           $oldName,
                           $newName,
                           $options,
                           $propertyListHandle);

This function renames a file or directory in the guest operating system.

Parameters

vmHandle

Identifies a virtual machine. Call VMOpen() to create a virtual machine handle.

oldName

The path to the file to be renamed.

newName

The path to the new file.

options

Must be 0.

propertyListHandle

Must be VIX_INVALID_HANDLE.

Return Value

Remarks

• You must call VMLoginInGuest before calling this function.
• Only absolute paths should be used for files in the guest; the resolution of relative paths is not specified.
• On Windows guests, it fails on directory moves when the destination is on a different volume.
• Because of the differences in how various operating systems handle filenames, Vix may return either VIX_E_INVALID_ARG or VIX_E_FILE_NAME_TOO_LONG for filenames longer than 255 characters.

Side Effects

Requirements

use VMware::Vix::Simple;
use VMware::Vix::API::Constants;