PrlVm_GetState Function

Obtains a handle of type PHT_VM_INFO containing the specified virtual machine state and access rights information.

Syntax

PRL_HANDLE PrlVm_GetState(
    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.

Remarks

To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function. Possible values are:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

To get the results from the PHT_JOB object:

Use the PrlJob_GetResult function to obtain a handle to the PHT_RESULT object.

Use the PrlResult_GetParam function to obtain the PHT_VM_INFO handle.

Example

hJob =
PrlVm_GetState( hVm );
PrlJob_Wait( hJob, 10000 );
PrlJob_GetResult( hJob, &hJobResult );
PrlHandle_Free( hJob );

// Get the handle from job
PRL_HANDLE hHandle;
PrlResult_GetParam( hJobResult, &hHandle );

Links

PHT_VIRTUAL_MACHINE, Example