Skip to content

Latest commit

 

History

History
87 lines (66 loc) · 5.75 KB

nf-fsrmpipeline-ifsrmclassifiermoduleimplementation-getpropertyvaluetoapply.md

File metadata and controls

87 lines (66 loc) · 5.75 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:fsrmpipeline.IFsrmClassifierModuleImplementation.GetPropertyValueToApply
IFsrmClassifierModuleImplementation::GetPropertyValueToApply (fsrmpipeline.h)
Retrieves the value from the classifier that should be applied for the specified property of the file most recently specified by the IFsrmClassifierModuleImplementation::OnBeginFile method.
GetPropertyValueToApply
GetPropertyValueToApply method [File Server Resource Manager]
GetPropertyValueToApply method [File Server Resource Manager]
IFsrmClassifierModuleImplementation interface
IFsrmClassifierModuleImplementation interface [File Server Resource Manager]
GetPropertyValueToApply method
IFsrmClassifierModuleImplementation.GetPropertyValueToApply
IFsrmClassifierModuleImplementation::GetPropertyValueToApply
fs.ifsrmclassifiermoduleimplementation_getpropertyvaluetoapply
fsrm.ifsrmclassifiermoduleimplementation_getpropertyvaluetoapply
fsrmpipeline/IFsrmClassifierModuleImplementation::GetPropertyValueToApply
fsrm\ifsrmclassifiermoduleimplementation_getpropertyvaluetoapply.htm
fsrm
70277473-de96-40e1-980b-4eec6e7b035d
12/05/2018
GetPropertyValueToApply, GetPropertyValueToApply method [File Server Resource Manager], GetPropertyValueToApply method [File Server Resource Manager],IFsrmClassifierModuleImplementation interface, IFsrmClassifierModuleImplementation interface [File Server Resource Manager],GetPropertyValueToApply method, IFsrmClassifierModuleImplementation.GetPropertyValueToApply, IFsrmClassifierModuleImplementation::GetPropertyValueToApply, fs.ifsrmclassifiermoduleimplementation_getpropertyvaluetoapply, fsrm.ifsrmclassifiermoduleimplementation_getpropertyvaluetoapply, fsrmpipeline/IFsrmClassifierModuleImplementation::GetPropertyValueToApply
fsrmpipeline.h
Windows
None supported
Windows Server 2008 R2
SrmSvc.dll
Windows
19H1
IFsrmClassifierModuleImplementation::GetPropertyValueToApply
fsrmpipeline/IFsrmClassifierModuleImplementation::GetPropertyValueToApply
c++
APIRef
kbSyntax
COM
SrmSvc.dll
IFsrmClassifierModuleImplementation.GetPropertyValueToApply

IFsrmClassifierModuleImplementation::GetPropertyValueToApply

-description

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

-parameters

-param property [in]

Name of the property.

-param value [out]

Value of the property.

-param idRule [in]

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 IFsrmClassifierModuleImplementation::UseRulesAndDefinitions method. The rule object can also be obtained by using this identifier in a call to the IFsrmCollection::GetById method on this collection.

-param idPropDef [in]

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 IFsrmClassifierModuleImplementation::UseRulesAndDefinitions method. The property definition object can also be obtained by using this identifier in a call to the IFsrmCollection::GetById method on this collection.

-returns

The method returns the following return values. Implementers should return an HRESULT error code for any other errors.

-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 IFsrmClassifierModuleImplementation::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