PrlVm_GetStatistics Function

Obtains a handle of type PHT_SYSTEM_STATISTICS containing the virtual machine resource usage information, including CPU(s), memory, disk drives, processes, user session, system uptime, network packets, etc.

Syntax

PRL_HANDLE PrlVm_GetStatistics(
    PRL_HANDLE hVm
);

File

PrlApi.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

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 value are:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

To get the results from the PHT_JOB object:

Use the PrlJob_GetResult function to obtain a handle to the PHT_RESULT object.

Use the PrlResult_GetParam function to obtain a handle of type PHT_SYSTEM_STATISTICS containing the resource usage data.

Links

PrlApi.h , PHT_VIRTUAL_MACHINE