PrlShare_IsReadOnly Function

Determines if the share is read-only.

Syntax

PRL_RESULT PrlShare_IsReadOnly(
    PRL_HANDLE hVmShare, 
    PRL_BOOL_PTR pbReadOnly
);

File

PrlApiVm.h

Parameters

hVmShare

A handle of type PHT_SHARE identifying the shared folder.

pbReadOnly

[out] A pointer to a variable that receives the result. PRL_TRUE indicates that the share is read-only (files can be read and copied but not modified). PRL_FALSE indicates that the folder contents can be modified.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.