Edit

Share via

IWICMetadataWriter::RemoveValueByIndex method (wincodecsdk.h)

  • Article

Removes the metadata item at the specified index.

Syntax

HRESULT RemoveValueByIndex(
  [in] UINT nIndex
);

Parameters

[in] nIndex

Type: UINT

The index of the metadata item to remove.

Return value

Type: HRESULT

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

Remarks

After removing an item, expect the remaining metadata items to move up to occupy the vacated metadata item location. Therefore indices 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