# Name

VixPropertyID

# Description

These are the possible IDs for Vix properties. To retrieve a property from a handle, pass the ID for the property you want.

# Values

VIX_PROPERTY_NONE
  Indicates that no value has been assigned to this property variable. Recommended for initializing property variables.

# Virtual Machine Properties

The following properties may be available from virtual machine handles:

# Values

VIX_PROPERTY_VM_NUM_VCPUS
  The number of virtual CPUs configured for the virtual machine.

VIX_PROPERTY_VM_VMX_PATHNAME
  The path to the virtual machine configuration file.

VIX_PROPERTY_VM_VMTEAM_PATHNAME
  The path to the virtual machine team.

VIX_PROPERTY_VM_MEMORY_SIZE
  The memory size of the virtual machine.

VIX_PROPERTY_VM_READ_ONLY

VIX_PROPERTY_VM_IN_VMTEAM
  Whether the virtual machine is a member of a team.

VIX_PROPERTY_VM_POWER_STATE
  The power state of the virtual machine. For a list of values, see Topics > Types > VixPowerState.

VIX_PROPERTY_VM_TOOLS_STATE
  The state of the VMware Tools suite in the guest.

VIX_PROPERTY_VM_IS_RUNNING
  Whether the virtual machine is running.

VIX_PROPERTY_VM_SUPPORTED_FEATURES

# Job Handle Properties

The following properties may be available from job handles:

# Values

VIX_PROPERTY_JOB_RESULT_ERROR_CODE
  The most recent error encountered by the job.

VIX_PROPERTY_JOB_RESULT_VM_IN_GROUP

VIX_PROPERTY_JOB_RESULT_USER_MESSAGE
  A user message blocking the virtual machine.

VIX_PROPERTY_JOB_RESULT_EXIT_CODE

VIX_PROPERTY_JOB_RESULT_COMMAND_OUTPUT

VIX_PROPERTY_JOB_RESULT_HANDLE
  A handle resulting from an asynchronous operation.

VIX_PROPERTY_JOB_RESULT_GUEST_OBJECT_EXISTS

VIX_PROPERTY_JOB_RESULT_GUEST_PROGRAM_ELAPSED_TIME
  The time it took to execute a program with VixVM_RunProgramInGuest().

VIX_PROPERTY_JOB_RESULT_GUEST_PROGRAM_EXIT_CODE
  The exit code resulting from VixVM_RunProgramInGuest().

VIX_PROPERTY_JOB_RESULT_ITEM_NAME
  For VixJob_GetNthProperties(), the name of an item found.

VIX_PROPERTY_JOB_RESULT_FOUND_ITEM_DESCRIPTION
  For VixJob_GetNthProperties(), the description of an item found.

VIX_PROPERTY_JOB_RESULT_SCREEN_IMAGE_DATA
  a Blob property containing the screen image

VIX_PROPERTY_JOB_RESULT_SCREEN_IMAGE_SIZE
  an integer property containing the size of the image, in bytes

VIX_PROPERTY_JOB_RESULT_SHARED_FOLDER_COUNT

VIX_PROPERTY_JOB_RESULT_SHARED_FOLDER_HOST

VIX_PROPERTY_JOB_RESULT_SHARED_FOLDER_FLAGS

VIX_PROPERTY_JOB_RESULT_PROCESS_ID

VIX_PROPERTY_JOB_RESULT_PROCESS_OWNER

VIX_PROPERTY_JOB_RESULT_PROCESS_COMMAND

VIX_PROPERTY_JOB_RESULT_FILE_FLAGS

VIX_PROPERTY_JOB_RESULT_PROCESS_START_TIME

VIX_PROPERTY_JOB_RESULT_PROCESS_BEING_DEBUGGED

# Event Properties

The following properties may be available from event handles:

# Values

VIX_PROPERTY_FOUND_ITEM_LOCATION

# Snapshot Properties

The following properties may be available from snapshot handles:

# Values

VIX_PROPERTY_SNAPSHOT_DISPLAYNAME
  User defined name for the snapshot.

VIX_PROPERTY_SNAPSHOT_DESCRIPTION
  User defined description for the snapshot.

# Requirements

vix.h, since VMware Server 1.0.

# Example

This example retrieves the a property from a job handle.

    VixError err = VIX_OK;
    VixHandle jobHandle = VIX_INVALID_HANDLE;
    VixHandle hostHandle = VIX_INVALID_HANDLE;

    // Create a new handle:
    jobHandle = VixHost_Connect(...);

    // Retrieve the host handle from the job property list:
    err = VixJob_Wait(jobHandle,
                      VIX_PROPERTY_JOB_RESULT_HANDLE,
                      &hostHandle,
                      VIX_PROPERTY_NONE);
    if (VIX_OK != err) {
       // Handle the error...
       goto abort;
    }

    // Release job handle when done:
    Vix_ReleaseHandle(jobHandle);

Copyright (C) 2007-2008 VMware, Inc. All rights reserved.