I_IrmPolicyInfoRMS.HrGetSignedIL Method

Applies to: SharePoint Foundation 2010

Gets the signed issuance license (IL) for the specified document.

HRESULT HrGetSignedIL(
    BSTR *pbstrIL
) PURE;

Parameters

pbstrIL

[out] The IL that SharePoint Foundation obtained for the document.

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

When SharePoint Foundation calls an integrated IRM protector to protect a document, SharePoint Foundation first obtains a license for that document and stores the license inside the I_IrmPolicyInfoRMS object that SharePoint Foundation passes to the protector when invoking the HrProtect method. The HrGetSignedIL method provides the protector a means to access the document IL.

The integrated protector need not read or understand the IL; it simply has to store the data inside the protected file. SharePoint Foundation already applied the Rights Management Services (RMS) public key to the IL, so the IL is already signed and can be stored in the file by the protector without modification or encryption.

This method should be called only from I_IrmProtector.HrProtect Method.

For more information about 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