I_IrmPolicyInfoRMS.HrGetListGuid Method
Applies to: SharePoint Foundation 2010
Returns the GUID of the document library from which the rights-managed document was downloaded.
HRESULT HrGetListGuid(
BSTR* pbstrListGuid
) PURE;
Parameters
pbstrListGuid
[out] The GUID of the document library from which the protected document was downloaded.
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 a user checks in a rights-managed document, that file must be uploaded to the same document library from which it was downloaded. To ensure this behavior, when the user downloads the document SharePoint Foundation includes the document library GUID in the document issuance license (IL) that the integrated Information Rights Management (IRM) protector then stores in the rights-managed document. When the user checks in the document, the IRM protector extracts the document IL and forwards it to SharePoint Foundation by using the HrSetSignedIL method. The IRM protector does not need to understand the IL itself. SharePoint Foundation is responsible for comparing the document library GUID in the document IL and the GUID of the document library to which the user is attempting to upload the document. If the GUIDs do not match, SharePoint Foundation cancels the upload.
Invoking this method is optional. SharePoint Foundation manages the process of comparing the document library GUIDs in a way that is transparent to the IRM protector.
However, if necessary, the IRM protector can access the document library GUID by using this method. The protector is not required to store the GUID inside the protected file, and a standard protector implementation that uses SharePoint Foundation IRM capability would not need to use this function.
This method can be used when the IRM protector is creating an IL, or when it must create content in an encrypted form from which the IRM infrastructure can remove protection.
For more information about integrated IRM protectors, see Custom IRM Protectors.