IFsrmPropertyBag interface (fsrmpipeline.h)
Contains the classification properties for a file.
FSRM passes this interface to your IFsrmPipelineModuleImplementation implementation. For more information, see the Remarks section.
Inheritance
The IFsrmPropertyBag interface inherits from the IDispatch interface. IFsrmPropertyBag also has these types of members:
Methods
The IFsrmPropertyBag interface has these methods.
| IFsrmPropertyBag::AddMessage Adds an error message to the bag. |
| IFsrmPropertyBag::get_Attributes The attributes of the file. |
| IFsrmPropertyBag::get_CreationTime The date and time that the file was created. |
| IFsrmPropertyBag::get_FileId The NTFS file identifier of the file. |
| IFsrmPropertyBag::get_FilePropertyNames A list of the names of the properties that the bag contains. |
| IFsrmPropertyBag::get_LastAccessTime The date and time of when the file was last accessed. |
| IFsrmPropertyBag::get_LastModificationTime The date and time of when the file was last modified. |
| IFsrmPropertyBag::get_Messages A list of the error messages that have been added to the bag. |
| IFsrmPropertyBag::get_Name The name of the file that contains the properties in the bag. |
| IFsrmPropertyBag::get_OwnerSid The SID of the owner of the file. |
| IFsrmPropertyBag::get_ParentDirectoryId The NTFS identifier of the file's parent directory. |
| IFsrmPropertyBag::get_PropertyBagFlags A set of flags that provide additional information about the property bag. |
| IFsrmPropertyBag::get_RelativeNamespaceRoot The relative path of the namespace root under which the file is being evaluated. |
| IFsrmPropertyBag::get_RelativePath The relative path to the file. |
| IFsrmPropertyBag::get_Size The size of the file. |
| IFsrmPropertyBag::get_SizeAllocated The allocation size of the file. |
| IFsrmPropertyBag::get_VolumeIndex The index that the scanner uses to refer to the volume on which the file exists. |
| IFsrmPropertyBag::get_VolumeName The name of the volume on which the file exists. |
| IFsrmPropertyBag::GetFileProperty Retrieves the specified property from the property bag. |
| IFsrmPropertyBag::GetFileStreamInterface Retrieves a file stream interface that you can use to access the contents of the file. |
| IFsrmPropertyBag::SetFileProperty Sets the specified property in the property bag. |
Remarks
A property bag contains an in-memory copy of all the properties for a file. The list of properties in the property bag may include additional properties not defined in FSRM. These properties can be the result of other metadata in the file.
This interface can be sent to IFsrmClassifierModuleImplementation::DoesPropertyValueApply and IFsrmClassifierModuleImplementation::GetPropertyValueToApply if a classifier module is implemented, or to IFsrmStorageModuleImplementation::LoadProperties and IFsrmStorageModuleImplementation::SaveProperties if a storage module is implemented.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | None supported |
| Minimum supported server | Windows Server 2008 R2 |
| Target Platform | Windows |
| Header | fsrmpipeline.h (include FsrmPipeline.h, FsrmQuota.h, FsrmReports.h, FsrmScreen.h) |
See also
IFsrmClassifierModuleImplementation
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for