PrlNetworkShapingEntry_Create Function

Creates a new handle of type PHT_NETWORK_SHAPING .

Syntax

PRL_RESULT PrlNetworkShapingEntry_Create(
    PRL_UINT32 nClassId, 
    PRL_UINT32 nTotalRate, 
    PRL_HANDLE_PTR phNetworkShapingEntry
);

nClassId

Network class id

nTotalRate

Specifies bound rate for network class phNetworkShapingEntry:[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 a virtual network object.

PRL_ERR_SUCCESS - function completed successfully.

The handle is necessary to configure network shaping configuration.

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