Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlVmCfg_GetOpticalDisk Function
PHT_VM_CONFIGURATION

Obtains a handle of type PHT_VIRTUAL_DEV_OPTICAL_DISK containing information a virtual optical disk in a virtual machine.

Syntax
PRL_RESULT PrlVmCfg_GetOpticalDisk(
    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 optical disk instance (beginning with 0). To determine the number of optical disks in a virtual machine, use the PrlVmCfg_GetOpticalDisksCount 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, or device index out of bound. 

PRL_ERR_SUCCESS - function completed successfully. 

Links
© 2021 Parallels International GmbH. All rights reserved.