DRMCreateEnablingBitsDecryptor 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 DRMCreateEnablingBitsDecryptor function creates a decryption object that is used to decrypt content data.

Syntax

DRMEXPORT HRESULT UDAPICALL DRMCreateEnablingBitsDecryptor(
  [in]           DRMHANDLE hBoundLicense,
  [in, optional] PWSTR     wszRight,
  [in]           DRMHANDLE hAuxLib,
  [in, optional] PWSTR     wszAuxPlug,
  [out]          DRMHANDLE *phDecryptor
);

Parameters

[in] hBoundLicense

A handle to a bound license object created by using DRMCreateBoundLicense.

[in, optional] wszRight

An optional null-terminated string that contains the right to exercise. A decrypting object can be bound to only one right at a time.

[in] hAuxLib

Reserved for future use. This parameter must be NULL.

[in, optional] wszAuxPlug

Reserved for future use. This parameter must be NULL.

[out] phDecryptor

A pointer to the decrypting object.

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 consuming application performs the following steps to decrypt content previously encrypted by a publishing application.

1. Retrieve an end-user license. Call DRMEnumerateLicense to retrieve the license if it already exists in the store. If function succeeds, go to step 2. If the license is not in the store, call DRMAcquireLicense followed by DRMEnumerateLicense.
2. Call DRMCreateBoundLicense to create a license that binds to one or more rights in the end-user license. The bound license includes a symmetric key that can be used for decryption.
3. Call DRMCreateEnablingBitsDecryptor to create a decrypting object associated with the bound right and content key.
4. Call DRMDecrypt to use the content key to decrypt the content.

Call the DRMCloseHandle function to close the decrypting object handle when you are finished with it. Both the decrypting object handle and the bound license handle must remain open until decryption is complete.

Requirements

See also

AD RMS Functions

DRMCreateEnablingBitsEncryptor

Decrypting Content