IFsrmClassifierModuleImplementation.OnBeginFile Method (IFsrmPropertyBag, Object[])

 

Instructs the classifier to prepare for processing a file with the specified property bag.

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

Syntax

void OnBeginFile(
    IFsrmPropertyBag propertyBag,
    object[] arrayRuleIds
)

void OnBeginFile(
    IFsrmPropertyBag^ propertyBag,
    array<Object^>^ arrayRuleIds
)

abstract OnBeginFile : 
        propertyBag:IFsrmPropertyBag *
        arrayRuleIds:Object[] -> unit

Sub OnBeginFile (
    propertyBag As IFsrmPropertyBag,
    arrayRuleIds As Object()
)

Parameters

• propertyBag
  Type: Microsoft.Storage.IFsrmPropertyBag

  The property bag that corresponds to the file to be processed.

• arrayRuleIds
  Type: System.Object[]

  A SAFEARRAY of variants that contains one or more strings listing the identifiers of rules that will be processed. Each identifier corresponds to a rule object that is in the rule collection passed in by a previous call to the UseRulesAndDefinitions method. The rule object can also be obtained by using this identifier in a call to the GetById method on this collection.

Remarks

The classifier is not allowed to directly call SetFileProperty on the property bag that is passed in. The classifier instead provides property values when the DoesPropertyValueApply method or the GetPropertyValueToApply method is called by FSRM.

Each of the calls to the DoesPropertyValueApply method or the GetPropertyValueToApply method is associated with a rule, the identifiers of which are passed in through the arrayRuleIds parameter. As an optimization, the classifier may optionally pre-compute the responses for the DoesPropertyValueApply method or the GetPropertyValueToApply method during the OnBeginFile method call using the rule identifiers passed in through the arrayRuleIds parameter.If FSRM_E_INCOMPATIBLE_FORMAT or FSRM_E_FILE_ENCRYPTED is returned, FSRM will not indicate that the file has failed classification. If any other error value is returned, FSRM will indicate that the file has failed classification.

See Also

IFsrmClassifierModuleImplementation Interface
Microsoft.Storage Namespace

Return to top