IWMProfileManager::LoadProfileByData method (wmsdkidl.h)

Article
4/26/2023

[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.]

The LoadProfileByData method creates a profile object and populates it with data from a stored string. You must use this method to manipulate custom profiles. System profiles should be accessed using either LoadProfileByID or LoadSystemProfile.

Syntax

HRESULT LoadProfileByData(
  [in]  const WCHAR *pwszProfile,
  [out] IWMProfile  **ppProfile
);

Parameters

[in] pwszProfile

Pointer to a wide-character null-terminated string containing the profile. Profile strings are limited to 153600 wide characters.

[out] ppProfile

Pointer to a pointer to an IWMProfile interface.

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_OUTOFMEMORY	There is not enough available memory.
E_INVALIDARG	Either the ppProfile or pwszProfile parameter is NULL.

Remarks

This string must match an XML-formatted string created by IWMProfileManager::SaveProfile. By convention, when such strings are saved to disk they are given the ".prx" extension.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only],Windows Media Format 7 SDK, or later versions of the SDK
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	wmsdkidl.h (include Wmsdk.h)
Library	Wmvcore.lib; WMStubDRM.lib (if you use DRM)

Share via