DRMDuplicateEnvironmentHandle function (msdrm.h)

Article
02/22/2024

[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 DRMDuplicateEnvironmentHandle function creates a copy of an environment handle.

Syntax

DRMEXPORT HRESULT UDAPICALL DRMDuplicateEnvironmentHandle(
  [in]  DRMENVHANDLE hToCopy,
  [out] DRMENVHANDLE *phCopy
);

Parameters

[in] hToCopy

A handle to copy. An environment handle is created by using DRMInitEnvironment.

[out] phCopy

A copy of the handle. Call DRMCloseEnvironmentHandle 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 allows an application to keep a proper reference count on environment handles, so use this function, rather than simply copy assignment, to copy an environment handle. For other handles, use DRMDuplicateHandle. Call DRMCloseEnvironmentHandle to close the environment handle created by calling this function.

Requirements

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