Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlShare_SetDescription Function
PHT_SHARE  See Also

Sets the shared folder description.

Syntax
PRL_RESULT PrlShare_SetDescription(
    PRL_HANDLE hVmShare, 
    PRL_CONST_STR sNewShareDescription
);
File

PrlApiVm.h

Parameters

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).

Returns

PRL_RESULT. Possible values: 

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed. 

PRL_ERR_SUCCESS - function completed successfully. 

See Also
Links
© 2021 Parallels International GmbH. All rights reserved.