I_IrmPolicyInfo.HrGetPolicyDescription Method

Applies to: SharePoint Foundation 2010

Gets the policy description for the document library in which the requested file is located.

HRESULT HrGetPolicyDescription(
    BSTR* pbstrPolicyDescription
    );

Parameters

pbstrPolicyDescription

[out] The policy description for the document library in which the requested file is located.

Return Value

All I_IrmPolicyInfo Class methods return HRESULT values. A positive OK value indicates the operation was successful. A negative return value indicates that the function did not succeed.

In general, if an I_IrmPolicyInfo Class method fails, the protector will not be able to recover from the error and will fail as well.

Remarks

This method enables the I_IrmProtector.HrProtect Method method of an autonomous Information Rights Management (IRM) protector to determine the policy description for the document library in which the requested file is located.

Every document library that is rights-managed has an IRM policy title and an IRM policy description. This IRM policy description can be used to provide users with additional information about the IRM policy that is being enforced. For example:

"Only distribute this document to full time employees"

The IRM policy title and description should be stored in the rights-managed file so that an IRM-aware client application can display them.

For more information about integrated and autonomous protectors, see Custom IRM Protectors.

See Also

Reference

I_IrmProtector Interface

I_IrmPolicyInfo Class

Concepts

Information Rights Management in SharePoint Foundation

Custom IRM Protectors