PrlVmDev_GetDescription Function

Returns the description of a specified virtual device.

Syntax

PRL_RESULT PrlVmDev_GetDescription(
    PRL_HANDLE hVmDev, 
    PRL_STR sDescription, 
    PRL_UINT32_PTR pnDescriptionBufLength
);

File

PrlApiVm.h

Parameters

hVmDev

A handle identifying the virtual device.

sDescription

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

pnDescriptionBufLength

[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 pnDescriptionBufLength parameter will contain the required size.

PRL_ERR_SUCCESS - function completed successfully.