# Name

VixPropertyType

# Description

These are the possible types for Vix properties. Property types are returned by the Vix_GetPropertyType() function.

# Values

VIX_PROPERTYTYPE_ANY
  Indicates that no property type has been assigned to this variable. Recommended for initializing property type variables.

VIX_PROPERTYTYPE_INTEGER
  The property type is 'int'.

VIX_PROPERTYTYPE_STRING
  The property type is 'char *'.

VIX_PROPERTYTYPE_BOOL
  The property type is Boolean.

VIX_PROPERTYTYPE_HANDLE
  The property type is VixHandle.

VIX_PROPERTYTYPE_INT64
  The property type is 'int64'.

VIX_PROPERTYTYPE_BLOB
  The property type is 'char *". When returned as a job property, the blob is returned as two values: first an 'int' containing the blob size in bytes, then a pointer to the blob.

# Requirements

vix.h, since VMware Server 1.0.

# Example

This example retrieves and tests a property type.

    VixError err = VIX_OK;
    VixHandle jobHandle = VIX_INVALID_HANDLE;
    VixHandle myHandle = VIX_INVALID_HANDLE;
    VixPropertyType myPropertyType = VIX_PROPERTYTYPE_ANY;

    // Create a new handle:
    jobHandle = VixHost_Connect(...);
    err = VixJob_Wait(jobHandle,
                      VIX_PROPERTY_NONE);
    if (VIX_OK != err) {
       // Handle the error...
       goto abort;
    }

    // Check the property type:
    err = Vix_GetPropertyType(jobHandle,
                              VIX_PROPERTY_JOB_RESULT_HANDLE,
                              &myPropertyType);
    if (VIX_OK != err) {
       // Handle the error...
       goto abort;
    }
    ASSERT(VIX_PROPERTYTYPE_HANDLE == myPropertyType);

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

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