PrlNetworkRate_Create Function

Creates a new handle of type PHT_NETWORK_RATE.

Syntax

PRL_RESULT PrlNetworkRate_Create(
    PRL_UINT32 nClassId, 
    PRL_UINT32 nRate, 
    PRL_HANDLE_PTR phNetworkRate
);

PrlApiNet.h

nClassId

Network class id

nRate

Specifies bound rate for network class

phNetwork

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

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - null pointer was passed.

PRL_ERR_OUT_OF_MEMORY - not enough memory to create the object.

PRL_ERR_SUCCESS - function completed successfully.

The handle is necessary to configure Vm output bandwidth.

It is the responsibility of the caller to free the handle with the PrlHandle_Free call when it is no longer needed.