I_IrmPolicyInfoRMS.HrGetICrypt Method

Applies to: SharePoint Foundation 2010

Gets a cryptographic object capable of encoding and decoding the specified document.

HRESULT HrGetICrypt(
    I_IrmCrypt **piic
) PURE;

Parameters

piic

[out] A cryptographic object capable of encoding and decoding the specified 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.

Some functions return more-robust error codes, but these codes are not enumerated here. In general, if an I_IrmPolicyInfoRMS method fails, the protector cannot recover from the error and also fails.

Remarks

The actual encryption and decryption of rights-managed documents is performed by the I_IrmCrypt object, not the integrated Information Rights Management (IRM) protector itself. The I_IrmCrypt object also performs the encoding and decoding of unencrypted data included in the protected document.

When creating a protected document, an integrated protector can immediately use this method to access the I_IrmCrypt object instantiated for the current document.

When an IRM protector generates an unprotected version of a document, the protector must call the HrSetSignedIL method before accessing the I_IrmCrypt object returned by this method. We strongly recommend that the protector also call the HrSetServerEUL method before accessing the I_IrmCrypt object returned by this 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