PrlHandle_GetChannelStatistics Function

Retrieves IO channel statistics (throughput, delay) for correspond virtual machine or remote desktop control object.

Syntax

PRL_RESULT PrlHandle_GetChannelStatistics(
    PRL_HANDLE hObj, 
    PRL_IO_CHANNEL_STAT_PTR channelStat
);

File

PrlApiCore.h

Parameters

hObj

A handle of type PHT_SERVER, PHT_VIRTUAL_MACHINE or PHT_DESKTOP_CONTROL.

channelStat

A pointer to the statistics structure

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed. PRL_ERR_NO_DATA - mostly indicates there is no connection to remote desktop now available. I.e. PrlDevDisplay_ConnectToVm was not called.

PRL_ERR_SUCCESS - function completed successfully.

Links

Handle Functions