IFsrmClassificationManager::GetRule method

[This method is supported for compatibility but it's recommended to use the FSRM WMI Classes to manage FSRM. Please see the MSFT_FSRMClassification class.]

Retrieves the specified rule.

Syntax


HRESULT GetRule(
  [in]  BSTR         ruleName,
  [in]  FsrmRuleType ruleType,
  [out] IFsrmRule    **rule
);

Parameters

ruleName [in]

The name of the rule to retrieve. Must not exceed 100 characters in length.

ruleType [in]

The type of the rule to retrieve. For possible types, see the FsrmRuleType enumeration.

Note  The FsrmRuleType_Generic type is not supported by this method.
 
rule [out]

An IFsrmRule interface to the retrieved rule. Query the IFsrmRule interface to get the interface for the specified type. For example, if ruleType is FsrmRuleType_Classification, query the IFsrmRule interface for the IFsrmClassificationRule interface.

Return value

The method returns the following return values.

S_OK

Success

E_INVALIDARG

Returned for any of the following reasons:

  • The ruleType parameter is FsrmRuleType_Generic.
  • The specified name is too long.
FSRM_E_NOT_FOUND

The specified rule was not found.

FSRM_E_INVALID_NAME

The specified name is empty or NULL.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2

Header

FsrmPipeline.h (include FsrmPipeline.h or FsrmTlb.h)

DLL

SrmSvc.dll

CLSID

CLSID_FsrmClassificationManager is defined as b15c0e47-c391-45b9-95c8-eb596c853f3a

IID

IID_IFsrmClassificationManager is defined as d2dc89da-ee91-48a0-85d8-cc72a56f7d04

IID_IFsrmClassificationManager2 is defined as 0004c1c9-127e-4765-ba07-6a3147bca112

See also

IFsrmClassificationManager2
IFsrmClassificationManager
IFsrmClassificationManager::CreateRule
IFsrmClassificationManager::EnumRules
FsrmClassificationManager
MSFT_FSRMClassification

 

 

Show: