PrlVmCfg_GetDefaultVideoRamSize Function

The PrlVmCfg_GetDefaultVideoRamSize function returns the default video RAM size for the specified OS type and version.

Syntax

PRL_RESULT PrlVmCfg_GetDefaultVideoRamSize(
    PRL_UINT32 guestOsVersion, 
    PRL_HANDLE hSrvConfig, 
    PRL_BOOL bIs3DSupportEnabled, 
    PRL_UINT32_PTR pnVideoRamSize
);

File

PrlApiVm.h

Parameters

guestOsVersion

Operating system version. See PrlOses.h for type definitions.

hSrvConfig

Optional. The host hardware info object handle (PHT_SERVER_CONFIG type) contains necessary information about host hardware configuration (amount of RAM, host type and etc.). For some operating system, this parameter may be used to calculate the default video RAM size more precisely.

bIs3DSupportEnabled

sign which specifies whether 3D support will be enabled at creating VM. 3D support require at least 128 Mb of video RAM in common case.

pnVideoRamSize

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

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

When creating a virtual machine using a default configuration, the default video memory size is defined for every supported operating system type and version. The default sizes can be retrieved using this function. The OS types are defined in the PrlOses.h file as macros. Look for the macros that are prefixed with PVS_GUEST_TYPE_ (e.g. PVS_GUEST_TYPE_MACOS). The OS versions can be found in the same file. The names of the macros are prefixed with PVS_GUEST_VER_ (e.g. PVS_GUEST_VER_MACOS_LEOPARD).

Links

PHT_VM_CONFIGURATION