IFsrmPropertyBag Interface

 

Contains the classification properties for a file.

Namespace:   Microsoft.Storage
Assembly:  srmlib (in srmlib.dll)

<GuidAttribute("774589D1-D300-4F7A-9A24-F7B766800250")>
Public Interface IFsrmPropertyBag

NameDescription
System_CAPS_pubpropertyAttributes

Retrieves the attributes of the file.

System_CAPS_pubpropertyCreationTime

Retrieves the date and time that the file was created.

System_CAPS_pubpropertyFileId

Retrieves the NTFS file identifier of the file.

System_CAPS_pubpropertyFilePropertyNames

Retrieves a list of the names of the properties that the bag contains.

System_CAPS_pubpropertyLastAccessTime

Retrieves the date and time of when the file was last accessed.

System_CAPS_pubpropertyLastModificationTime

Gets the date and time of when the file was last modified.

System_CAPS_pubpropertyMessages

Retrieves a list of the error messages that have been added to the bag.

System_CAPS_pubpropertyName

The name of the file that contains the properties in the bag.

System_CAPS_pubpropertyOwnerSid

The SID of the owner of the file.

System_CAPS_pubpropertyParentDirectoryId

Retrieves the NTFS identifier of the file's parent directory.

System_CAPS_pubpropertyPropertyBagFlags

A set of flags that provide additional information about the property bag.

System_CAPS_pubpropertyRelativeNamespaceRoot

Retrieves the relative path of the namespace root under which the file is being evaluated.

System_CAPS_pubpropertyRelativePath

Retrieves the relative path to the file.

System_CAPS_pubpropertySize

Gets the size of the file.

System_CAPS_pubpropertySizeAllocated

Gets the allocation size of the file.

System_CAPS_pubpropertyVolumeIndex

Gets the index that the scanner uses to refer to the volume on which the file exists.

System_CAPS_pubpropertyVolumeName

Gets the name of the volume on which the file exists.

NameDescription
System_CAPS_pubmethodAddMessage(String)

Adds an error message to the bag.

System_CAPS_pubmethodGetFileProperty(String)

Retrieves the specified property from the property bag.

System_CAPS_pubmethodGetFileStreamInterface(_FsrmFileStreamingMode, _FsrmFileStreamingInterfaceType)

Retrieves a file stream interface that you can use to access the contents of the file.

System_CAPS_pubmethodSetFileProperty(String, String)

Sets the specified property in the property bag.

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 DoesPropertyValueApply and GetPropertyValueToApply if a classifier module is implemented, or to LoadProperties and SaveProperties if a storage module is implemented.

Return to top

Community Additions

ADD
Show: