IWMDeviceRegistration::GetRegisteredDeviceByID method (wmsdkidl.h)

[The feature associated with this page, Windows Media Format 11 SDK, is a legacy feature. It has been superseded by Source Reader and Sink Writer. Source Reader and Sink Writer have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Source Reader and Sink Writer instead of Windows Media Format 11 SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

[GetRegisteredDeviceByID is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. Instead, use Microsoft PlayReady. ]

The GetRegisteredDeviceByID method retrieves information about a registered device by the device identifier.

Syntax

HRESULT GetRegisteredDeviceByID(
  [in]  DWORD               dwRegisterType,
  [in]  BYTE                *pbCertificate,
  [in]  DWORD               cbCertificate,
  [in]  DRM_VAL16           SerialNumber,
  [out] IWMRegisteredDevice **ppDevice
);

Parameters

[in] dwRegisterType

The type of the device for which to retrieve information. Devices that support Windows Media DRM 10 for Network Devices use the DRM_DEVICE_REGISTER_TYPE_STREAMING register type.

[in] pbCertificate

Address of the device certificate in memory.

[in] cbCertificate

The size of the certificate data in bytes.

[in] SerialNumber

128-bit device identifier, stored in a DRM_VAL16 structure.

[out] ppDevice

Address of a variable that receives a pointer to an IWMRegisteredDevice interface. This interface provides access to information about the registered device in the list that matches the other identifying parameters.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
The method succeeded.
E_INVALIDARG
The ppDevice parameter is NULL.

OR

The pbCertificate parameter is NULL, but the cbCertificate parameter is greater than zero.

NS_E_DRM_DEVICE_NOT_REGISTERED
The specified device is not registered.

Remarks

When your application receives messages from a device, you can use the methods of the IWMDRMMessageParser interface to extract the device certificate and device identifier. You can identify the device by using that data as inputs to this method.

The DRM_DEVICE_REGISTER_TYPE_STORAGE register type is defined, but is not used in this release.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only],Windows Media Format 9.5 SDK
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header wmsdkidl.h (include Wmsdk.h)
Library WMStubDRM.lib

See also

IWMDeviceRegistration Interface