PrlStat_GetUserStat Function

Obtains a handle of type PHT_SYSTEM_STATISTICS_USER_SESSION containing the specified user session statistics.

Syntax

PRL_RESULT PrlStat_GetUserStat(
    PRL_HANDLE hStat, 
    PRL_UINT32 nIndex, 
    PRL_HANDLE_PTR phUserStat
);

File

PrlApi.h

Parameters

hStat

A handle of type PHT_SYSTEM_STATISTICS.

nIndex

A numeric index identifying the user session statistics object instance (beginning with 0). To determine the number of instances, use the PrlStat_GetUsersStatsCount function.

phUserStat

[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.d

Links

PrlApi.h, PHT_SYSTEM_STATISTICS