DRMSetRevocationPoint function (msdrm.h)

[The AD RMS SDK leveraging functionality exposed by

the client in Msdrm.dll is available for use in Windows Server 2008, Windows Vista, Windows Server 2008 R2, Windows 7, Windows Server 2012, and Windows 8. It may be altered or

unavailable in subsequent versions. Instead, use Active Directory Rights Management Services SDK 2.1,

which leverages functionality exposed by the client in Msipc.dll.]

The DRMSetRevocationPoint function sets a refresh rate and location to obtain a revocation list.

Syntax

DRMEXPORT HRESULT UDAPICALL DRMSetRevocationPoint(
  [in] DRMPUBHANDLE hIssuanceLicense,
  [in] BOOL         fDelete,
  [in] PWSTR        wszId,
  [in] PWSTR        wszIdType,
  [in] PWSTR        wszURL,
  [in] SYSTEMTIME   *pstFrequency,
  [in] PWSTR        wszName,
  [in] PWSTR        wszPublicKey
);

Parameters

[in] hIssuanceLicense

A handle to an issuance license.

[in] fDelete

Flag indicating whether the existing item should be deleted: TRUE indicates it should be deleted; FALSE indicates it should be added.

[in] wszId

ID of the revocation authority posting the revocation list. This must match the ID given in the ISSUER node of the revocation list.

[in] wszIdType

Type of ID used by wszId.

[in] wszURL

URL of revocation file list.

[in] pstFrequency

How often the list must be updated.

[in] wszName

Optional human-readable name for a revocation list site.

[in] wszPublicKey

Public key of key pair used to sign and verify the revocation list.

Return value

If the function succeeds, the function returns S_OK.

If the function fails, it returns an HRESULT value that indicates the error. Possible values include, but are not limited to, those in the following list. For a list of common error codes, see Common HRESULT Values.

Remarks

A revocation list can revoke end-user licenses, server licensor certificates, or almost anything else with an identifying GUID. For a list of the items that can be revoked, see Revocation. The URL provided should refer to the list file itself. The rights management system handles checking for a valid revocation list. This function should only be called once, since subsequent calls will overwrite the previous revocation point in the issuance license.

The public key must be a base-64 encoded string.

Note that if there is no revocation point set in the license, the license can still be revoked by a revocation list signed by the issuer of the license.

Requirements

See also

AD RMS Functions

DRMGetRevocationPoint

Revoking a Certificate