Data structures
FTHFolderData
Folder object data
| Data Type | Field Name | Description |
|---|---|---|
| int | FolderID | ID of a newly created folder |
| int | ParentFolderID | ID of a parent folder |
| string | Name | Name of new folder |
| int | EffectivePermission | Effective access permission for new folder for currently signed user 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 |
| DateTime | DateCreated | Timestamp when the folder was created |
| DateTime | DateModified | Timestamp when the folder was modified |
| int | CreatedByUserID | ID of the user who created the file |
| int | ModifiedByUserID | ID of the user who modified the file |
| bool | IsDeleted | Flag shows if the folder is deleted |
| int | FolderType | One of the following Folder Types: Regular = 0, Root = 1, UserHome = 2, UserDocuments = 3, UserDropBox = 4, FolderRoot = 5, HomeRoot = 6, |
FTHFolderSearchPagingData
Paging data for search results
| Data Type | Field Name | Description |
|---|---|---|
| string | SearchString | Search pattern for folders, use asterisk symbol for wildcard |
| int | RequestedStartIndex | Starting index to return a page of results |
| int | RequestedLength | Number of results on the page |
| int | TotalMatchingFolders | Total count of matched folders |
| FTHFolderData[] | PageFolders | Array of folder descriptors returned by the search |
FTHFileData
File object data
| Data Type | Field Name | Description |
|---|---|---|
| int | FileID | ID of a file in MFT FS server |
| int | ParentFolderID | ID of a parent folder that contains a file |
| string | Name | Name of a file |
| long | Size | File size |
| int | EffectivePermission | Effective permission of a file (reserved for future use) |
| DateTime | DateCreated | Date when a file was created |
| DateTime | DateModified | Date when a file was modified last time |
| int | CreatedByUserID | ID of the user who created the file |
| Int | ModifiedByUserID | ID of the user who modified the file last time |
| int | Version | File version (reserved for future use) |
| bool | IsDeleted | Flag shows if a file is in Deleted state |
| bool | IsQuarantined | Flag shows if a file is in Quarantined state, means that file body was removed by Anti-virus software. |
| bool | IsPublished | Flag shows that a file is published into one of MFT FS collections. |
FTHFileSearchPagingData
Paging data for file searches
| Data Type | Field Name | Description |
|---|---|---|
| string | SearchString | Search pattern for folders, use asterisk symbol for wildcard |
| int | RequestedStartIndex | Starting index to return a page of results |
| int | RequestedLength | Number of results on the page |
| int | TotalMatchingFiles | Total count of matched files |
| FTHFileData [] | PageFiles | Array of file descriptors returned by the search |
Was this topic helpful?