PrlIPPrivNet_Create Function

Creates a new handle of type PHT_IPPRIV_NET .

Syntax

PRL_RESULT PrlIPPrivNet_Create(
    PRL_HANDLE_PTR phPrivNet
);

File

PrlApi.h

Parameters

phPrivNet

[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 an IP private network. If you would like to create a new IP private network, use this function to create the handle first and then use the handle functions to configure the network. If you would like to modify the configuration of an existing network, use the PrlSrv_GetIPPrivateNetworksList function to obtain a handle to the private 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_IPPRIV_NET