I_IrmPolicyInfoRMS.HrGetServerID Method

Applies to: SharePoint Foundation 2010

Returns the ID of the process under which SharePoint Foundation is running; this process is the sole owner of the protected file.

HRESULT HrGetServerId(
    BSTR *pbstrServerId
) PURE;

Parameters

pbstrServerID

[out] The ID of the process under which SharePoint Foundation is running; this process is the sole owner of the protected file.

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 file, the file may include several end-user licenses (EULs) from multiple users. As part of the process of removing protection from the file, the integrated Information Rights Management (IRM) protector must extract the server EUL and forward it to SharePoint Foundation. To assist the protector, the protector can use this method to retrieve the server ID. The protector can then use the server ID to identify the correct EUL to forward to SharePoint Foundation.

This technique of identifying the server EUL is optional. Developers can also design the storage of rights-managed data in a file in such a way that the server EUL can be found without knowing the server ID.

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