Waiting for engine...
Skip to main content

Data structures

FTHFolderData

Folder object data

Data TypeField NameDescription
intFolderIDID of a newly created folder
intParentFolderIDID of a parent folder
stringNameName of new folder
intEffectivePermissionEffective 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
DateTimeDateCreatedTimestamp when the folder was created
DateTimeDateModifiedTimestamp when the folder was modified
intCreatedByUserIDID of the user who created the file
intModifiedByUserIDID of the user who modified the file
boolIsDeletedFlag shows if the folder is deleted
intFolderTypeOne 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 TypeField NameDescription
stringSearchStringSearch pattern for folders, use asterisk symbol for wildcard
intRequestedStartIndexStarting index to return a page of results
intRequestedLengthNumber of results on the page
intTotalMatchingFoldersTotal count of matched folders
FTHFolderData[]PageFoldersArray of folder descriptors returned by the search

FTHFileData

File object data

Data TypeField NameDescription
intFileIDID of a file in MFT FS server
intParentFolderIDID of a parent folder that contains a file
stringNameName of a file
longSizeFile size
intEffectivePermissionEffective permission of a file (reserved for future use)
DateTimeDateCreatedDate when a file was created
DateTimeDateModifiedDate when a file was modified last time
intCreatedByUserIDID of the user who created the file
IntModifiedByUserIDID of the user who modified the file last time
intVersionFile version (reserved for future use)
boolIsDeletedFlag shows if a file is in Deleted state
boolIsQuarantinedFlag shows if a file is in Quarantined state, means that file body was removed by Anti-virus software.
boolIsPublishedFlag shows that a file is published into one of MFT FS collections.

FTHFileSearchPagingData

Paging data for file searches

Data TypeField NameDescription
stringSearchStringSearch pattern for folders, use asterisk symbol for wildcard
intRequestedStartIndexStarting index to return a page of results
intRequestedLengthNumber of results on the page
intTotalMatchingFilesTotal count of matched files
FTHFileData []PageFilesArray of file descriptors returned by the search
On this Page