PrlShare_GetDescription Function

Returns the shared folder description.

Syntax

PRL_RESULT PrlShare_GetDescription(
    PRL_HANDLE hVmShare, 
    PRL_STR sShareDescription, 
    PRL_UINT32_PTR pnShareDescriptionBufLength
);

File

PrlApiVm.h

Parameters

hVmShare

A handle of type PHT_SHARE identifying the shared folder.

sShareDescription

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

pnShareDescriptionBufLength

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