Waiting for engine...
Skip to main content

Manage Folder metadata

Data Structures

FolderMetadataResult

Folder metadata in a form of name = value pairs

Data TypeField NameDescription
intFolderMetadataIDID of a newly created metadata item for a folder
intFolderIDID of a folder for which metadata is created
stringNameMetadata item name
intDataTypeType of the data
stringDataValue

Methods

CreateFolderMetadata

Creates metadata for a specific folder in MFT FS file system.

FolderMetadataResult  
CreateFolderMetadata(Guid sessionID, int folderID, string name, string data)
Parameter NameDescription
sessionIDUser session returned by one of the Open functions
folderIDID for the folder for which metadata is created
nameName for a new metadata item
dataString with the data that will populate metadata item

GetFolderMetadata

Retrieves metadata for specific MFT FS folder

FolderMetadataResult[]  
GetFolderMetadata (Guid sessionID, int folderID)
Parameter NameDescription
sessionIDUser session returned by one of the Open functions
folderIDID for the folder for which metadata is retrieved

SaveFolderMetadata

Updates metadata for a specific folder in MFT FS file system. If metadata with the input name does not exist for the folder ID, exception will be thrown.

note

Metadata with the name Description will be displayed as a folder description in web UI and returned by the API.

FolderMetadataResult  
SaveFolderMetadata(Guid sessionID, int folderID, string name, string data)
Parameter NameDescription
sessionIDUser session returned by one of the Open functions
folderIDID for the folder for which metadata is created
nameName for a new metadata item
dataString with the data that will populate metadata item
On this Page