PrlVmInfo_IsInvalid Function

Determines if the specified virtual machine is invalid.

Syntax

PRL_RESULT PrlVmInfo_IsInvalid(
    PRL_HANDLE handle, 
    PRL_BOOL_PTR pbIsInvalid
);

File

PrlApiVm.h

Parameters

handle

A handle of type PHT_VM_INFO.

pVmIsInvalid

[out] A pointer to a variable that receives result. PRL_TRUE - the virtual machine is invalid. PRL_FALSE - the virtual machine is fully operational.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_NO_DATA - the status of the virtual machine cannot be determined.

RL_ERR_SUCCESS - function completed successfully.

Remarks

A virtual machine can be reported as invalid by the function if its configuration has been corrupted, it's been removed from the virtual machine, and for other similar reasons.

Links

PHT_VM_INFO