PrlVmCfg_GetExpirationNote Function

Gets expiration note.

Syntax

PRL_RESULT PrlVmCfg_GetExpirationNote(
    PRL_HANDLE hVmCfg, 
    PRL_STR sNote, 
    PRL_UINT32_PTR pnNoteBufLength
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

sNote

[out] A pointer to a buffer that receives the result (a UTF-8 encoded, null-terminated string).

pnNoteBufLength

[in] The size of the output buffer (in bytes). Set the buffer pointer to null and this parameter's value to zero to receive the required size. [out] The required output buffer size.

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle was passed.

PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_VM_CONFIGURATION