# Name

VixToolsState

# Description

These are the possible values reported for VIX_PROPERTY_VM_TOOLS_STATE. They represent runtime information about the VMware Tools suite in the guest operating system. To test the value of the property, use the Vix_GetProperties() function.

# Values

VIX_TOOLSSTATE_UNKNOWN
  Indicates that Vix is unable to determine the VMware Tools status.

VIX_TOOLSSTATE_RUNNING
  Indicates that VMware Tools is running in the guest operating system.

VIX_TOOLSSTATE_NOT_INSTALLED
  Indicates that VMware Tools is not installed in the guest operating system.

# Requirements

vix.h, since VMware Server 1.0.

# Example

This example retrieves the Tools state of a virtual machine.

    VixError err = VIX_OK;
    VixHandle myVM = VIX_INVALID_HANDLE;
    VixToolsState toolsState = 0;

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

    // Test the Tools state.
    err = Vix_GetProperties(myVM,
                            VIX_PROPERTY_VM_TOOLS_STATE,
                            &toolsState,
                            VIX_PROPERTY_NONE);
    if (VIX_OK != err) {
      // Handle the error...
    }

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