Collapse All
Virtuozzo Virtualization SDK C API Reference
ContentsIndex
PreviousUpNext
PrlSrv_GetVmListEx Function
PHT_SERVER

Retrieves a list of virtual machines registered with the specified Virtuozzo Service.

Syntax
PRL_HANDLE PrlSrv_GetVmListEx(
    PRL_HANDLE hServer, 
    PRL_UINT32 nFlags
);
File

PrlApiVm.h

Parameters

hServer
A handle of type PHT_SERVER identifying the Virtuozzo Service.
nFlags
Flags bitset of PRL_GET_VM_LIST_FLAGS enumerator.

Returns

A handle of type PHT_JOB containing the results of this asynchronous operation or PRL_INVALID_HANDLE if there's not enough memory to instantiate the job object.

Remarks

The information about each virtual machine is returned as a handle of type PHT_VIRTUAL_MACHINE

To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function. Possible values are: 

PRL_ERR_INVALID_ARG - invalid handle was passed. 

PRL_ERR_SUCCESS - function completed successfully. 

To get the result from the PHT_JOB object:

  1. Use the PrlJob_GetResult function to obtain a handle to the PHT_RESULT object.
  2. Use the PrlResult_GetParamsCount function to get the number of virtual machine in the result set.
  3. Use the PrlResult_GetParamByIndex function in a loop, or by passing a specific index, to obtain a handle to each virtual machine.

Links
Copyright ©2016-2017 Parallels International GmbH. All rights reserved.