CHAPTER 3 Operations on Host Machines
27
RC1
VixHost_FindItems
Function Signature
VixHandle
VixHost_FindItems(VixHandle hostHandle,
VixFindItemType searchType,
VixHandle searchCriteria,
int32 timeout,
VixEventProc *callbackProc,
void *clientData);
Parameters
Results
VixHandle. A job handle that describes the state of this asynchronous call.
Notes
This function asynchronously finds VIX objects and calls the application’s callback
function to report each object found. For example, when used to find all running
virtual machines,
VixHost_FindItems() returns a series of virtual machine file path
names.
Each time
VixHost_FindItems() calls the callback function, it passes the following
things to the callback function:
• When an object is found,
VixHost_FindItems() passes the value
VIX_EVENTTYPE_FIND_ITEM
in the eventType parameter.
• When an object is found,
VixHost_FindItems() passes a property list object
containing the location of the object found. The property list is passed as the
value of the moreEventInfo parameter. The property list contains a single
hostHandle The host handle returned by VixHost_Connect().
searchType The type of items to find. Must be VIX_FIND_RUNNING_VMS in this
release.
searchCriteria Must be VIX_INVALID_HANDLE.
timeout Must be -1.
callbackProc A function to be invoked when VixHost_FindItems() completes.
clientData A user-supplied parameter to be passed to the callback function.
