PrlStat_GetCpuStat Function

Obtains a handle of type PHT_SYSTEM_STATISTICS_CPU containing the specified CPU statistics.

Syntax

PRL_RESULT PrlStat_GetCpuStat(
    PRL_HANDLE hStat, 
    PRL_UINT32 nIndex, 
    PRL_HANDLE_PTR phCpuStat
);

File

PrlApiStat.h

Parameters

hStat

A handle of type PHT_SYSTEM_STATISTICS.

nIndex

A numeric index identifying the CPU statistics object instance (beginning with 0). To get the number of instances, use the PrlStat_GetCpusStatsCount function.

phCpuStat

[out] A pointer to a variable that receives the handle.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_SYSTEM_STATISTICS