IFsrmClassifierModuleImplementation.GetPropertyValueToApply Method (String, String, Guid, Guid)

  • Article

 

Retrieves the value from the classifier that should be applied for the specified property of the file most recently specified by the OnBeginFile method.

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

Syntax

void GetPropertyValueToApply(
    string property,
    out string Value,
    Guid idRule,
    Guid idPropDef
)

void GetPropertyValueToApply(
    String^ property,
    [OutAttribute] String^% Value,
    Guid idRule,
    Guid idPropDef
)

abstract GetPropertyValueToApply : 
        property:string *
        Value:string byref *
        idRule:Guid *
        idPropDef:Guid -> unit

Sub GetPropertyValueToApply (
    property As String,
    <OutAttribute> ByRef Value As String,
    idRule As Guid,
    idPropDef As Guid
)

Parameters

  • idRule
    Type: System.Guid

    The identifier of the rule object associated with the property value being queried. This rule object should be 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 IFsrmClassifierModuleDefinition:: NeedsExplicitValue property of the classifier's module definition is VARIANT_TRUE.

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_FILE_ENCRYPTED, FSRM_E_INCOMPATIBLE_FORMAT, or FSRM_E_NO_PROPERTY_VALUE 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