PrlSrv_GetVmListEx Function

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

Syntax

PRL_HANDLE PrlSrv_GetVmListEx(
    PRL_HANDLE hServer, 
    PRL_UINT32 nFlags
);

File

PrlApi.h

Parameters

hServer

A handle of type PHT_SERVER identifying the Parallels Service.

nFlags

Flags bitset of PRL_VM_TYPE_FLAGS enumerator, filter Vm by Vm type.

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:

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

Links

PrlApi.h , PHT_SERVER