IWMPContentPartner::GetCatalogURL method (contentpartner.h)

Article
4/26/2023

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

Note This section describes functionality designed for use by online stores. Use of this functionality outside the context of an online store is not supported.

The GetCatalogURL method retrieves the URL from which to retrieve an update to the online store's current catalog.

Syntax

HRESULT GetCatalogURL(
  [in]  DWORD   dwCatalogVersion,
  [in]  DWORD   dwCatalogSchemaVersion,
  [in]  LCID    catalogLCID,
  [out] DWORD   *pdwNewCatalogVersion,
  [out] BSTR    *pbstrCatalogURL,
  [out] VARIANT *pExpirationDate
);

Parameters

[in] dwCatalogVersion

DWORD containing the current catalog version.

[in] dwCatalogSchemaVersion

DWORD containing the current catalog schema version.

[in] catalogLCID

The locale ID (LCID) for the catalog.

[out] pdwNewCatalogVersion

Address of a DWORD that receives the new catalog version.

[out] pbstrCatalogURL

Address of a BSTR that receives the URL.

[out] pExpirationDate

Address of a VARIANT (VT_DATE) that receives the expiration date of the catalog update.

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.

Remarks

We recommend that the catalog URL specify the version as part of the path. For example, http://www.contoso.com/Catalogs/210/catalog.wmdb.

Requirements


Minimum supported client	Windows Media Player 11
Target Platform	Windows
Header	contentpartner.h