PrlVirtNet_Create Function

Creates a new handle of type PHT_VIRTUAL_NETWORK .

Syntax

PRL_RESULT PrlVirtNet_Create(
    PRL_HANDLE_PTR phVirtNet
);

File

PrlApi.h

Parameters

phVirtNet

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

Returns

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.

Remarks

The handle is necessary to create and configure virtual networks. If you would like to create a new virtual network, use this function to create the handle first and then use its functions to configure the network. If you would like to modify the configuration of an existing virtual network, use the PrlSrv_GetVirtualNetworkList function to obtain a handle to the virtual network of interest.

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

Links

PrlApi.h , PHT_VIRTUAL_NETWORK