IWMHeaderInfo3::DeleteAttribute 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 DeleteAttribute method removes an attribute from the file header.

Syntax

HRESULT DeleteAttribute(
  [in] WORD wStreamNum,
  [in] WORD wIndex
);

Parameters

[in] wStreamNum

WORD containing the stream number for which the attribute applies. Setting this value to zero indicates a file-level attribute.

[in] wIndex

WORD containing the index of the attribute to be deleted.

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_NOTIMPL	The method is not implemented on a reader object.
NS_E_INVALIDREQUEST	wStreamNum is not a valid stream number, or there is not an attribute at wIndex.

Remarks

You can use 0xFFFF for the stream number to specify an attribute using its global index. Global index values range from 0 to one less than the count of attributes received from a call to IWMHeaderInfo3::GetAttributeCountEx where the stream number was set to 0xFFFF.

When deleting multiple attributes, you should do so in descending order by index value. For convenience, this is the order in which index values are retrieved by IWMHeaderInfo3::GetAttributeIndices.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only],Windows Media Format 9 Series 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)

Partager via