Export (0) Print
Expand All

IWICMetadataBlockWriter::SetWriterByIndex method

Replaces the metadata writer at the specified index location.

Syntax


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

See also

IWICMetadataBlockWriter
Conceptual
WIC Metadata Overview
Overview of Reading and Writing Image Metadata
How-to: Re-encode a JPEG Image with Metadata
Other Resources
How to Write a WIC-Enabled CODEC

 

 

Community Additions

ADD
Show:
© 2014 Microsoft