IFsrmClassifierModuleImplementation.DoesPropertyValueApply Method (String, String, Boolean, Guid, Guid)

  • Article

 

Queries the classifier to find out whether the specified property value applies to the file most recently specified by the OnBeginFile method.

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

Syntax

void DoesPropertyValueApply(
    string property,
    string Value,
    out bool applyValue,
    Guid idRule,
    Guid idPropDef
)

void DoesPropertyValueApply(
    String^ property,
    String^ Value,
    [OutAttribute] bool% applyValue,
    Guid idRule,
    Guid idPropDef
)

abstract DoesPropertyValueApply : 
        property:string *
        Value:string *
        applyValue:bool byref *
        idRule:Guid *
        idPropDef:Guid -> unit

Sub DoesPropertyValueApply (
    property As String,
    Value As String,
    <OutAttribute> ByRef applyValue As Boolean,
    idRule As Guid,
    idPropDef As Guid
)

Parameters

  • Value
    Type: System.String

    Value of the property to check in the query.

  • applyValue
    Type: System.Boolean

    Is VARIANT_TRUE if the property applies; otherwise, VARIANT_FALSE.

  • idRule
    Type: System.Guid

    The identifier of the rule object associated with the property value being queried. This rule object 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.

  • idPropDef
    Type: System.Guid

    The identifier of the property definition object that corresponds to the property being queried. This property definition object is in the property definition collection passed in by a previous call to the UseRulesAndDefinitions method. The property definition object can also be obtained by using this identifier in a call to the GetById method on this collection.

Remarks

This method is called if the NeedsExplicitValue property of the classifier's module definition is VARIANT_FALSE.

The identifiers passed in the idRule and idPropDef parameters can be used by the classifier implementation to determine whether the property value applies to the file. For classifiers that require the associated rule and/or property definition to make the determination, it is suggested that implementers cache the corresponding collections passed to them during UseRulesAndDefinitions

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