DRMDeleteLicense function

[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 DRMDeleteLicense function deletes a license, client licensor certificate, revocation list, or issuance license template.

Syntax

DRMEXPORT HRESULT UDAPICALL DRMDeleteLicense(
  IN DRMHSESSION hSession,
  PWSTR          wszLicenseId
);

Parameters

hSession

A handle to a license storage session or client session. You can use a storage session handle to delete end-user licenses and revocation lists. You can use a client session handle to delete end-user licenses, rights account certificates, client licensor certificates, and issuance license templates.

You can retrieve a handle to a license storage session by using the DRMCreateLicenseStorageSession function. You can retrieve a handle to a client session by using the DRMCreateClientSession function.

wszLicenseId

A pointer to a null-terminated string that contains the ID of the license or template to be deleted. The license ID can be found inside the ID element of the license XrML, by querying using the license querying functions and the g_wszQUERY_CONTENTIDVALUE constant. The template ID is a GUID. You can enumerate the GUIDs by calling the DRMEnumerateLicense function.

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

The AD RMS system does not check to determine whether out of date licenses or revocation lists are stored in the license store, even when acquiring a new license or revocation list for content already owned. Therefore, it is important to occasionally delete licenses or certificates. This can be a time-consuming process, so it might be best to perform this action occasionally or during program idle time.

If you delete an end-user license, this function will not automatically delete associated revocation lists.

If you delete a license by using the content ID, the hSession parameter must be the handle of a client session.

License and certificate IDs can be enumerated by using DRMEnumerateLicense. If you already have the license or certificate you want to delete from the license store, you can query it for its ID (by using the DRMParseUnboundLicense and DRMGetUnboundLicenseAttribute functions with the g_wszQUERY_IDVALUE constant) and pass the value into this function.

Requirements

   
Target Platform Windows
Header msdrm.h
Library Msdrm.lib
DLL Msdrm.dll

See Also

AD RMS Functions

DRMEnumerateLicense

DRMGetUnboundLicenseAttribute

DRMParseUnboundLicense