Edit

Share via

IWICMetadataWriter::SetValueByIndex method (wincodecsdk.h)

  • Article

Sets the metadata item to the specified index.

Syntax

HRESULT SetValueByIndex(
  [in] UINT              nIndex,
  [in] const PROPVARIANT *pvarSchema,
  [in] const PROPVARIANT *pvarId,
  [in] const PROPVARIANT *pvarValue
);

Parameters

[in] nIndex

Type: UINT

The index to place the metadata item.

[in] pvarSchema

Type: const PROPVARIANT*

Pointer to the schema property of the metadata item.

[in] pvarId

Type: const PROPVARIANT*

Pointer to the id property of the metadata item.

[in] pvarValue

Type: const PROPVARIANT*

Pointer to the metadata value to set at the given index.

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