The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IWICMetadataBlockWriter::SetWriterByIndex method

Replaces the metadata writer at the specified index location.

Syntax

C++


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

Parameters

nIndex [in]

Type: UINT

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

pIMetadataWriter [in]

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

Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps \| Windows Store apps]
Minimum supported server	Windows Server 2008 [desktop apps \| Windows Store apps]
Header	Wincodecsdk.h
IDL	Wincodecsdk.idl
Library	Windowscodecs.lib
DLL	Windowscodecs.dll