DRMGetBoundLicenseObjectCount function (msdrm.h)

Article
10/13/2021

[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 DRMGetBoundLicenseObjectCount function retrieves the number of occurrences of an object within a specified branch of a license.

Syntax

DRMEXPORT HRESULT UDAPICALL DRMGetBoundLicenseObjectCount(
  [in]  DRMHANDLE hQueryRoot,
  [in]  PWSTR     wszSubObjectType,
  [out] UINT      *pcSubObjects
);

Parameters

[in] hQueryRoot

A handle to the branch of the license to query, from DRMGetBoundLicenseObject or DRMCreateBoundLicense.

[in] wszSubObjectType

The type of XrML object to find. For more information, see Remarks.

[out] pcSubObjects

Number of objects of this type within this branch.

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

Certain license structures, such as a RIGHT structure, may have multiple instances in a license. This method returns a count of these occurrences, so that an application can iterate through them to access a particular one by using DRMGetBoundLicenseObject.

The Active Directory Rights Management system exposes an object-oriented interface to the underlying license XrML. This function, along with other DRMGetBoundLicense_xxx functions, allows an application to navigate this structure. For more information, see Querying Licenses.

Requirements

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