PrlVmCfg_SetExpirationNote Function

Sets expiration note.

Syntax

PRL_RESULT PrlVmCfg_SetExpirationNote(
    PRL_HANDLE hVmCfg, 
    PRL_CONST_STR sNote
);

PrlApiVm.h

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

sNote

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

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle was passed.

PRL_ERR_SUCCESS - function completed successfully.