IFsrmPropertyBag Interface

Contains the classification properties for a file.

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

Syntax

[GuidAttribute("774589D1-D300-4F7A-9A24-F7B766800250")]
public interface IFsrmPropertyBag

[GuidAttribute("774589D1-D300-4F7A-9A24-F7B766800250")]
public interface class IFsrmPropertyBag

[<GuidAttribute("774589D1-D300-4F7A-9A24-F7B766800250")>]
type IFsrmPropertyBag = interface end

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

Properties

	Name	Description
	Attributes	Retrieves the attributes of the file.
	CreationTime	Retrieves the date and time that the file was created.
	FileId	Retrieves the NTFS file identifier of the file.
	FilePropertyNames	Retrieves a list of the names of the properties that the bag contains.
	LastAccessTime	Retrieves the date and time of when the file was last accessed.
	LastModificationTime	Gets the date and time of when the file was last modified.
	Messages	Retrieves a list of the error messages that have been added to the bag.
	Name	The name of the file that contains the properties in the bag.
	OwnerSid	The SID of the owner of the file.
	ParentDirectoryId	Retrieves the NTFS identifier of the file's parent directory.
	PropertyBagFlags	A set of flags that provide additional information about the property bag.
	RelativeNamespaceRoot	Retrieves the relative path of the namespace root under which the file is being evaluated.
	RelativePath	Retrieves the relative path to the file.
	Size	Gets the size of the file.
	SizeAllocated	Gets the allocation size of the file.
	VolumeIndex	Gets the index that the scanner uses to refer to the volume on which the file exists.
	VolumeName	Gets the name of the volume on which the file exists.

Methods

	Name	Description
	AddMessage(String)	Adds an error message to the bag.
	GetFileProperty(String)	Retrieves the specified property from the property bag.
	GetFileStreamInterface(_FsrmFileStreamingMode, _FsrmFileStreamingInterfaceType)	Retrieves a file stream interface that you can use to access the contents of the file.
	SetFileProperty(String, String)	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 DoesPropertyValueApply and GetPropertyValueToApply if a classifier module is implemented, or to LoadProperties and SaveProperties if a storage module is implemented.

See Also

IFsrmClassifierModuleImplementation
IFsrmPipelineModuleImplementation
IFsrmStorageModuleImplementation
Microsoft.Storage Namespace

Return to top