I_IrmPolicyInfo.HrGetPolicyTitle Method
Applies to: SharePoint Foundation 2010
Gets the policy title for the document library in which the requested file is located.
HRESULT HrGetPolicyTitle(
BSTR* pbstrPolicyTitle
);
Parameters
pbstrPolicyTitle
[out] The policy title 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 title for the document library in which the requested file is located.
Every document library that is rights-managed has an IRM policy title. This IRM policy title can be used to inform users about the nature of the IRM policy that is being enforced. For example:
"Company Confidential – Do Not Distribute"
The IRM policy title should be stored in the rights-managed file so that an IRM-aware client application can display it.
For more information about integrated and autonomous protectors, see Custom IRM Protectors.