PrlAppliance_Create Function

Creates a new handle of type PHT_APPLIANCE_CONFIG.

Syntax

PRL_RESULT PrlAppliance_Create(
    PRL_HANDLE_PTR phAppCfg
);

File

PrlApiVm.h

Parameters

phAppCfg

[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 appliance download configuration. If you would like to create a new appliance download configuration, use this function to create the handle first and then use the handle functions to configure the appliance info.

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

Links

System Functions