PrlVmCfg_SetGuestSharingEnableSpotlight Function

Sets the VM virtual disks added to Spotlight search subsystem sign.

Syntax

PRL_RESULT PrlVmCfg_SetGuestSharingEnableSpotlight(
    PRL_HANDLE hVmCfg, 
    PRL_BOOL bVmGuestSharingEnableSpotlight
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

bVmGuestSharingEnableSpotlight

Enable Spotlight option to set. Specify PRL_TRUE to enable using virtual harddisks at Spotlight search subsystem. Specify PRL_FALSE to disable virtual hard disks from Spotlight.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

If guest sharing is enabled (see PrlVmCfg_SetGuestSharingEnabled) and Spotlight enable sign is turned on, the search through Spotlight subsystem will be using VM virtual hardisks too.

Parallels Tools must be installed to use this feature. To obtain the Parallels Tools status, use the PrlVm_GetToolsState function.

Links

PHT_VM_CONFIGURATION