DRMCloseHandle 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 DRMCloseHandle function closes handles to objects created with DRMCreate* functions and libraries loaded by using DRMLoadLibrary.

Syntax


HRESULT DRMCloseHandle(
  _In_ DRMHANDLE handle
);

Parameters

handle [in]

A handle to close.

Return value

If the function succeeds, the function returns S_OK.

If the function fails, it returns an HRESULT value that indicates the error. For a list of common error codes, see Common HRESULT Values.

Remarks

This function properly clears sensitive data from memory and allows the AD RMS system to keep an accurate reference count on objects used. If an object contains other open objects within it, calling this function will force all contained objects to be closed as well. However, forcing closure of contained objects in this way is not recommended.

If this function fails, an application should destroy the current process after closing the environment with DRMCloseEnvironmentHandle.

Closing a handle to a library will cause the library to be unloaded if it has no remaining open objects.

Requirements

Product

Rights Management Services client 1.0 SP2 or later

Header

Msdrm.h

Library

Msdrm.lib

DLL

Msdrm.dll

See also

AD RMS Handles and Sessions
AD RMS Functions

 

 

Show: