Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlVm_GetPerfStats Function
PHT_VIRTUAL_MACHINE

Obtains a handle of type PHT_EVENT containing the virtual machine performance statistics.

Syntax
PRL_HANDLE PrlVm_GetPerfStats(
    PRL_HANDLE hVm, 
    PRL_CONST_STR sFilter
);
File

PrlApiVm.h

Parameters

hVm
A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.
sFilter
String representing statistics filter, use char '*' at the end to get subset of statistic. Could be NULL, to get all statistic.

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

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_GetParam function to obtain a handle of type PHT_EVENT.
Links
© 2021 Parallels International GmbH. All rights reserved.