IWICMetadataBlockWriter::RemoveWriterByIndex method (wincodecsdk.h)

Article
02/22/2024

Removes the metadata writer from the specified index location.

Syntax

HRESULT RemoveWriterByIndex(
  [in] UINT nIndex
);

Parameters

[in] nIndex

Type: UINT

The index of the metadata writer to remove.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

After removing a metadata writer, remaining metadata writers can be expected to move up to occupy the vacated location. Indexes for remaining metadata items as well as the count will change.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	wincodecsdk.h
Library	Windowscodecs.lib
DLL	Windowscodecs.dll