PrlVmCfg_GetUsbDevice Function

Obtains a handle of type PHT_VIRTUAL_DEV_USB_DEVICE containing information about a USB device in a virtual machine.

Syntax

PRL_RESULT PrlVmCfg_GetUsbDevice(
    PRL_HANDLE hVmCfg, 
    PRL_UINT32 nIndex, 
    PRL_HANDLE_PTR phDevice
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

nIndex

An index identifying the USB device (beginning with 0). To determine the number of USB devices in a virtual machine, use the PrlVmCfg_GetUsbDevicesCount function.

phDevice

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

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_VM_CONFIGURATION