Name
VMDeleteDirectoryInGuest
Description
$err = VMDeleteDirectoryInGuest($vmHandle,
$pathName,
$options);
This function deletes a directory in the guest operating system.
Any files or subdirectories in the specified directory will also
be deleted.
Parameters
- vmHandle
-
Identifies a virtual machine. Call VMOpen() to create a virtual machine handle.
- pathName
-
The path to the directory to be deleted.
- options
-
Must be 0.
Return Value
$err. The error code returned by the operation. For returned values, see Topics > Error Codes.
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.
Side Effects
None.
Requirements
use VMware::Vix::Simple;
use VMware::Vix::API::Constants;
since VMware Workstation 6.0
Minimum Supported Guest OS: Microsoft Windows NT Series, Linux