IWICMetadataBlockWriter::SetWriterByIndex method (wincodecsdk.h)

Replaces the metadata writer at the specified index location.

Syntax

HRESULT SetWriterByIndex(
  [in] UINT               nIndex,
  [in] IWICMetadataWriter *pIMetadataWriter
);

Parameters

[in] nIndex

Type: UINT

The index position at which to place the metadata writer. This index is zero-based.

[in] pIMetadataWriter

Type: IWICMetadataWriter*

A pointer to the IWICMetadataWriter.

Return value

Type: HRESULT

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

Remarks

Typically, the current metadata writer at the specified index will be replaced with the new writer. However, the App0 metadata writer cannot be replaced within a JPEG stream.

This function cannot be used to add metadata writers. If no metadata writer exists at the specified index, the function will fail.

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

See also

Conceptual

How to Write a WIC-Enabled CODEC

How-to: Re-encode a JPEG Image with Metadata

IWICMetadataBlockWriter

Other Resources

Overview of Reading and Writing Image Metadata

WIC Metadata Overview