Package prlsdkapi :: Class VmShare
[hide private]
[frames] | no frames]

Class VmShare

  object --+            
           |            
 prlsdk.Base --+        
               |        
prlsdk.BaseAsync --+    
                   |    
prlsdk.OwnerRefAsync --+
                       |
                      VmShare

Provides methods for managing host shared folder accessibility in a virtual machine. Using these methods, you can make a host OS folder visible and accessible in a virtual machine.

Instance Methods [hide private]
 
remove(self)
Remove this share from the virtual machine configuration.

Inherited from prlsdk.OwnerRefAsync: __init__, __new__

Inherited from prlsdk.BaseAsync: __cmp__, __repr__, cancel, wait

Inherited from object: __delattr__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __setattr__, __str__

Class Variables [hide private]
  __prefix__ = 'share'
  __ht__ = 268435479
Properties [hide private]
  name
Shared folder name.
  path
Shared folder path.
  description
share.set_description(Share, new_share_description)
  enabled
Determines whether the shared folder is enabled.
  read_only
Determines whether the shared folder is read-only.

Inherited from prlsdk.OwnerRefAsync: __owner__

Inherited from prlsdk.BaseAsync: __expected_h_type__, __job__, finished, handle_type

Inherited from prlsdk.Base: __handle__

Inherited from object: __class__

Property Details [hide private]

name

Shared folder name.

Get Method:
unreachable.share__get_name(share, Share) - Returns VM shared folder name.
Set Method:
unreachable.share__set_name(share, Share, new_share_name) - Sets VM shared folder name.

path

Shared folder path.

Get Method:
unreachable.share__get_path(share, Share) - Returns VM shared folder path.
Set Method:
unreachable.share__set_path(share, Share, new_share_path) - Sets VM shared folder path.

description

share.set_description(Share, new_share_description)

Sets VM shared folder description.

Get Method:
unreachable.share__get_description(share, Share) - Returns VM shared folder description.
Set Method:
unreachable.share__set_description(share, Share, new_share_description) - Sets VM shared folder description.

enabled

Determines whether the shared folder is enabled. True - enabled; False - disabled.

Get Method:
unreachable.share__get_enabled(share, Share) - Returns VM shared folder enabling sign.
Set Method:
unreachable.share__set_enabled(share, Share, enabled) - Sets VM shared folder enabling sign.

read_only

Determines whether the shared folder is read-only. True - read only; False - writable.

Get Method:
unreachable.share__get_read_only(share, Share) - Returns VM shared folder read only sign.
Set Method:
unreachable.share__set_read_only(share, Share, read_only) - Sets VM shared folder read only sign.