PHT_SHARE

The PHT_SHARE handle is used to manage host shares. With this handle, you can make a host OS folder visible and accessible in a virtual machine. The handle is obtained by making the PrlVmCfg_GetShare or the PrlVmCfg_CreateShare function call.

Description

To create a new share:

Call the PrlVm_BeginEdit function to mark the beginning of the operation (this is essentially a virtual machine configuration modification, so it must be done within the begin/commit block).
Use the PrlVmCfg_CreateShare function to obtain the handle.
Use functions provided by this object to set the desired new share properties.
Call the PrlVm_Commit to finalize the changes.
Enabled the host sharing feature in the virtual machine by calling the PrlVm_SetHostSharingEnabled function.

To modify an existing share, use the PrlVmCfg_GetShare function to obtain a handle containing the share information. Then repeat the steps described above.

Functions

	Name	Description
	PrlShare_GetDescription	Returns the shared folder description.
	PrlShare_GetName	Returns the shared folder name (as it appears in the guest OS).
	PrlShare_GetPath	Returns the shared folder path.
	PrlShare_IsEnabled	Determines whether the share is enabled or not.
	PrlShare_IsReadOnly	Determines if the share is read-only.
	PrlShare_Remove	Removes the share from the virtual machine configuration.
	PrlShare_SetDescription	Sets the shared folder description.
	PrlShare_SetEnabled	Enables the specified share.
	PrlShare_SetName	Sets the share name (as it will appear in the guest OS).
	PrlShare_SetPath	Sets the shared folder path.
	PrlShare_SetReadOnly	Makes the specified shared folder read-only.

Links

Functions, Functions by Handle, Legend