IFsrmPropertyBag interface

Contains the classification properties for a file.

FSRM passes this interface to your IFsrmPipelineModuleImplementation implementation. For more information, see the Remarks section.

Members

The IFsrmPropertyBag interface inherits from the IDispatch interface. IFsrmPropertyBag also has these types of members:

Methods

The IFsrmPropertyBag interface has these methods.

MethodDescription
AddMessage

Adds a message about the file.

GetFileProperty

Retrieves the specified metadata property of the file.

GetFileStreamInterface

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

SetFileProperty

Sets the specified metadata property of the file.

 

Properties

The IFsrmPropertyBag interface has these properties.

PropertyAccess typeDescription

Attributes

Read-only

The attributes of the file.

CreationTime

Read-only

The date and time that the file was created.

FileId

Read-only

The file identifier of the file.

FilePropertyNames

Read-only

A list of the names of the file's metadata properties.

LastAccessTime

Read-only

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

LastModificationTime

Read-only

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

Messages

Read-only

A list of the classification messages.

Name

Read-only

The name of the file.

OwnerSid

Read-only

The SID of the owner of the file.

ParentDirectoryId

Read-only

The identifier of the file's parent directory.

PropertyBagFlags

Read-only

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

RelativeNamespaceRoot

Read-only

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

RelativePath

Read-only

The relative path to the file.

Size

Read-only

The size of the file.

SizeAllocated

Read-only

The allocation size of the file.

VolumeIndex

Read-only

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

VolumeName

Read-only

The name of the volume on which the file exists.

 

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

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2

Header

Fsrm.h (include FsrmPipeline.h, FsrmQuota.h, FsrmReports.h, or FsrmScreen.h)

DLL

SrmSvc.dll

IID

IID_IFsrmPropertyBag is defined as 774589d1-d300-4f7a-9a24-f7b766800250

See also

IFsrmClassifierModuleImplementation
IFsrmPipelineModuleImplementation
IFsrmStorageModuleImplementation

 

 

Show:
© 2014 Microsoft