2.4.3 Folder Permission Management

2.4.3.1 Data Structure

2.4.3.1.1 FTHPermissionListItemData

Note : in the definition of the object/structure FTHPermissionListItemData is that one call permission can be set either for userID or for usergroupID, but not for both

FTHPermissionListItemData
Holds the data on a single item in permission list

Data Type

Field Name

Description

int

FolderPermissionID

ID of a folder permission item

int

FolderID

ID of a folder for which permission is retrieved

int

Permission

Permission value Permission enum:
None = 0×00, //0
Show = 0×01, //1
Read = 0×02, //2
Create = 0×04, //4
Download = 0×08, //8
Distribute = 0×010, //16
Manage = 0×020, //32
Modify = 0×040, //64
Delete = 0×080, //128
FullControl = Read , Create , Download , Distribute , Manage , Modify , Delete

int

UserID

ID of a user whose permission is retrieved, equals to (-1) if permission is set for a group

int

UserGroupID

ID of a group whose permission is retrieved, equals to (-1) if permission is set for a user

2.4.3.2 Methods

2.4.3.2.1 GetFolderPermissionList

GetFolderPermissionList
Retrieves a list of permissions for a Thru folder

FTHPermissionListItemData []
GetFolderPermissionList (Guid sessionID, int folderID)

Parameter Name

Description

sessionID

User session returned by one of the Open functions

folderID

ID of the folder for which the permission is retrieved

2.4.3.2.2 SetFolderPermissionList

SetFolderPermissionList
Set permission list for a Thru folder

void
SetFolderPermissionList(Guid sessionID, int folderID, FTHPermissionListItemData[] newPermissionList)

Parameter Name

Description

SessionID

User session returned by one of the Open functions

FolderID

ID of the folder for which the permission is set

newPermissionList

List of permissions items, see specification of data structure FTHPermissionListItemData