Manage Folder metadata
Data Structures
FolderMetadataResult
Folder metadata in a form of name = value pairs
| Data Type | Field Name | Description |
|---|---|---|
| int | FolderMetadataID | ID of a newly created metadata item for a folder |
| int | FolderID | ID of a folder for which metadata is created |
| string | Name | Metadata item name |
| int | DataType | Type of the data |
| string | Data | Value |
Methods
CreateFolderMetadata
Creates metadata for a specific folder in MFT FS file system.
FolderMetadataResult
CreateFolderMetadata(Guid sessionID, int folderID, string name, string data)
| Parameter Name | Description |
|---|---|
sessionID | User session returned by one of the Open functions |
folderID | ID for the folder for which metadata is created |
name | Name for a new metadata item |
data | String with the data that will populate metadata item |
GetFolderMetadata
Retrieves metadata for specific MFT FS folder
FolderMetadataResult[]
GetFolderMetadata (Guid sessionID, int folderID)
| Parameter Name | Description |
|---|---|
sessionID | User session returned by one of the Open functions |
folderID | ID 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 Name | Description |
|---|---|
sessionID | User session returned by one of the Open functions |
folderID | ID for the folder for which metadata is created |
name | Name for a new metadata item |
data | String with the data that will populate metadata item |
Was this topic helpful?