PrlVm_GetToolsState Function

Obtains a handle of type PHT_VM_TOOLS_INFO containing information about the state of the Parallels Tools package in a virtual machine.

Syntax

PRL_HANDLE PrlVm_GetToolsState(
    PRL_HANDLE hVm
);

File

PrlApiVm.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

Returns

A handle of type PHT_JOB containing the results of this asynchronous operation or PRL_INVALID_HANDLE if there's not enough memory to instantiate the job object.

Example

The following example illustrates how to obtain a handle of type PHT_VM_TOOLS_INFO. The hVm variable is a handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

Copy Code

PRL_HANDLE hJob, hResult, hVmToolsInfo;

hJob = PrlVm_GetToolsState( hVm );
PrlJob_Wait( hJob, 1000 );

PrlJob_GetResult( hJob, &hResult );
PrlHandle_Free( hJob );

PrlResult_GetParam( hJobResult, &hVmToolsInfo );
PrlHandle_Free( hJobResult );

Links

PHT_VIRTUAL_MACHINE, Example