Name
VixHandleType
Description
These are the types of handles used as values for VixHandle variables.
Handle types are returned by the Vix_GetHandleType() function.
Handles are used to manage the entities they represent (such as virtual machines)
and to retrieve properties representing information about the entities.
Values
- VIX_HANDLETYPE_NONE
-
Indicates that no value has been assigned to this handle.
Recommended for initializing handle variables.
- VIX_HANDLETYPE_HOST
-
The handle represents a host.
This handle type is created when you call VixHost_Connect().
- VIX_HANDLETYPE_VM
-
The handle represents a virtual machine.
This handle type is created when you call VixVM_Open().
- VIX_HANDLETYPE_NETWORK
-
- VIX_HANDLETYPE_JOB
-
The handle represents an active job.
Job handles are return values from asynchronous operations,
including VixHost_Connect() and VixVM_Open().
- VIX_HANDLETYPE_SNAPSHOT
-
The handle represents a snapshot.
This handle type is created when you call snapshot functions such as VixVM_GetCurrentSnapshot().
Use these handles to revert or remove snapshots.
- VIX_HANDLETYPE_PROPERTY_LIST
-
The handle represents a property list.
This handle type is used to pass additional arguments to many functions.
Requirements
vix.h, since VMware Server 1.0.
Example
This example retrieves a handle type.
VixError err = VIX_OK;
VixHandle jobHandle = VIX_INVALID_HANDLE;
VixHandleType myHandleType = VIX_HANDLETYPE_NONE;
Create a new handle:
jobHandle = VixHost_Connect(...);
...
// Test the handle type:
myHandleType = Vix_GetHandleType(jobHandle);
ASSERT(VIX_HANDLETYPE_JOB == myHandleType);