PrlVmCfg_CreateVmDev Function

Creates a new virtual device handle of the specified type.

Syntax

PRL_RESULT PrlVmCfg_CreateVmDev(
    PRL_HANDLE hVmCfg, 
    PRL_DEVICE_TYPE nDeviceType, 
    PRL_HANDLE_PTR phVmDevice
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

nDeviceType

The type of the device to create a handle for.

phVmDevice

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

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

The names of the virtual device handles are prefixed with PHT_VIRTUAL_DEV_ (you may search this documentation for their definitions or see the _PRL_HANDLE_TYPE enumeration for a complete list of handles). It is the responsibility of the user to free the handle when it is no longer needed.

Links

PHT_VM_CONFIGURATION