PrlVmCfg_SetDescription Function

Sets the virtual machine description.

Syntax

PRL_RESULT PrlVmCfg_SetDescription(
    PRL_HANDLE hVmCfg, 
    PRL_CONST_STR sNewVmDescription
);

PrlApiVm.h

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

sNewVmDescription

The virtual machine description to set. The value must be a UTF-8 encoded, null-terminated string.

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.