I_IrmPolicyInfoRMS.HrSetServerEUL Method

Applies to: SharePoint Foundation 2010

Sets the end-user license (EUL) of the server.

HRESULT HrSetServerEUL(
    BSTR bstrEUL
) PURE;

Parameters

bstrEUL

[in] The server EUL.

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

To decrypt data inside a rights-managed file, SharePoint Foundation needs both the document issuance license (IL) and the server EUL. An integrated Information Rights Management (IRM) protector can use this method to set the server EUL. SharePoint Foundation uses the EUL to set up the decryption process.

Both the document IL and server EUL are stored inside the rights-managed file. The HrUnprotect method of the invoked IRM protector must be able to extract both these certificates from the protected document. The HrUnprotect method can then call HrSetSignedIL to set the IL for SharePoint Foundation, and HrSetServerEUL to set the server EUL.

The HrUnprotect method is not responsible for modifying the EUL in any way. SharePoint Foundation can decrypt the server EUL directly by using the private key of the server.

If a protector passes a NULL value for bstrEUL when calling HrSetServerEUL, SharePoint Foundation must contact the Rights Management Services (RMS) server and obtain a new EUL. This should be done only if the protector contains no stored EUL and the protector has called HrSetSignedIL.

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