PrlShare_SetDescription Function

Sets the shared folder description.

Syntax

PRL_RESULT PrlShare_SetDescription(
    PRL_HANDLE hVmShare, 
    PRL_CONST_STR sNewShareDescription
);

PrlApiVm.h

hVmShare

A handle of type PHT_SHARE identifying the shared folder.

sNewShareDescription

A user-defined share description (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.