PrlVmCfg_GetDescription Function

Returns the specified virtual machine description.

Syntax

PRL_RESULT PrlVmCfg_GetDescription(
    PRL_HANDLE hVmCfg, 
    PRL_STR sVmDescription, 
    PRL_UINT32_PTR pnVmDescriptionBufLength
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

sVmDescription

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

pnVmDescriptionBufLength

[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 are:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_BUFFER_OVERRUN - the size of the output buffer is not large enough. The parameter that is used to specify the size will contain the required size.

PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_VM_CONFIGURATION