I_IrmPolicyInfoRMS.HrGetRightsTemplate Method

Applies to: SharePoint Foundation 2010

Returns the rights-managed template included in the Information Rights Management (IRM) protected file.

HRESULT HrGetRightsTemplate(
    BSTR* pbstrRightsTemplate
) PURE;

Parameters

pbstrRightsTemplate

[out] A Rights Management Services (RMS) rights template that can be used to create new rights-managed content that is based on the server-supplied permission policy.

Return Value

All I_IrmPolicyInfoRMS methods return HRESULT values. A positive OK value indicates the operation succeeded. A negative return value indicates that the function did not succeed.

In general, if an I_IrmPolicyInfoRMS method fails, the protector cannot recover from the error and also fails.

Remarks

This function returns that same rights template that was used to create the issuance license (IL) for the current document.

This function allows integrated protectors to insert a rights template into the generated protected file. As a result, the client application can create new rights-managed content by using a fixed permission policy provided by SharePoint Foundation.

A standard protector implementation that uses SharePoint Foundation IRM capability would not need to use this function.

For more information on integrated IRM protectors, see Custom IRM Protectors.

See Also

Reference

I_IrmProtector Interface

I_IrmPolicyInfoRMS Class

I_IrmPolicyInfo Class

Concepts

Information Rights Management in SharePoint Foundation

Custom IRM Protectors