PrlSrvCfg_GetHardDisk Function

Obtains an object of type PHT_HW_HARD_DISK containing information about a hard disks drive on the host.

Syntax

PRL_RESULT PrlSrvCfg_GetHardDisk(
    PRL_HANDLE hSrvConfig, 
    PRL_UINT32 nIndex, 
    PRL_HANDLE_PTR phDevice
);

File

PrlApi.h

Parameters

hSrvConfig

A handle of type PHT_SERVER_CONFIG.

nIndex

A numeric index identifying the drive (beginning with 0). The number of drives in the list can be determined by making the PrlSrvCfg_GetHardDisksCount function call.

phDevice

[out] A pointer to a variable that receives a handle of type PHT_HW_HARD_DISK containing the drive information.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Links

PrlApi.h, PHT_SERVER_CONFIG