IWMBackupRestoreProps::GetPropByName 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.]

[GetPropByName 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 GetPropByName method retrieves the value of a property by name.

This method is not implemented.

Syntax

HRESULT GetPropByName(
  [in]      LPCWSTR           pszName,
  [out]     WMT_ATTR_DATATYPE *pType,
  [out]     BYTE              *pValue,
  [in, out] WORD              *pcbLength
);

Parameters

[in] pszName

Pointer to a wide-character null-terminated string containing the name.

[out] pType

Pointer to a variable containing one member of the WMT_ATTR_DATATYPE enumeration type.

[out] pValue

Pointer to a byte array containing the value of the property.

[in, out] pcbLength

On input, contains the length of pValue. On output, points to a count of the bytes in pValue that are used.

Return value

The method returns E_NOTIMPL.

Remarks

You should make two calls to GetPropByName. On the first call, pass NULL as pValue. On return, the value pointed to by pcbLength is set to the buffer size required to hold the property value. Then you can allocate the required amount of memory for the buffer and pass a pointer to it as pValue on the second call.

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