PrlVmDev_SetDescription Function

Sets the description for a specified virtual device.

Syntax

PRL_RESULT PrlVmDev_SetDescription(
    PRL_HANDLE hVmDev, 
    PRL_CONST_STR sNewDescription
);

PrlApiVm.h

hVmDev

A handle identifying the virtual device.

sNewDescription

The new 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.