Name

GetProperties

Description

@properties = GetProperties($handle, $firstPropertyID, ...);

This function allows you to get one or more properties from a handle. For a list of property IDs, see Topics > Types > VixPropertyID.

Parameters

handle: Any handle returned by a Vix function.
firstPropertyID: A property ID. See below for valid values.

Return Value

@properties. Returns the values of requested properties from the object pointed to by $handle. The first element in the list is an error code.

When GetProperties() returns an error, the values of the output parameters are indeterminate.

Remarks

This function allows you to get one or more properties from a handle. You may use this function on any type of handle, but only specific properties are defined for each handle.
This procedure accepts a variable number of parameters, so you can retrieve any number of properties with a single call. The parameters must be in a series of pairs of property IDs and result pointers. Each result pointer will accept the value of the property identified by the property ID in the previous parameter. The type of the pointer depends on the type of the property.
The value of VIX_PROPERTY_VM_TOOLS_STATE is valid only after calling VMWaitForToolsInGuest().

Side Effects

None.

Requirements

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

since VMware Server 1.0

Example

my $err;
my $myVM = VIX_INVALID_HANDLE;
my $vmPowerState;
my $vmPathName;


# ...Open the virtual machine and get a handle...

($err, $vmPowerState, $vmPathName) = GetProperties($myVM,
                                                   VIX_PROPERTY_VM_POWER_STATE,
                                                   VIX_PROPERTY_VM_VMX_PATHNAME);
if $err != VIX_OK # Handle the error