PrlVmCfg_IsArchived Function

Determines whether the virtual machine is in archived state

Syntax

PRL_RESULT PrlVmCfg_IsArchived(
    PRL_HANDLE hVmCfg, 
    PRL_BOOL_PTR pbArchived
);

PrlApiVm.h

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

pbArchived

[out] A pointer to a variable that receives the result. PRL_TRUE indicates that virtual machine is archived. PRL_FALSE indicates otherwise.

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer to buffer was passed.

PRL_ERR_SUCCESS - function completed successfully.