IWICMetadataQueryWriter::RemoveMetadataByName method (wincodec.h)

Article
02/22/2024

Removes a metadata item from a specific location using a metadata query expression.

Syntax

HRESULT RemoveMetadataByName(
  [in] LPCWSTR wzName
);

Parameters

[in] wzName

Type: LPCWSTR

The name 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

RemoveMetadataByName uses metadata query expressions to remove metadata. For more information on the metadata query language, see the Metadata Query Language Overview.

If the metadata item is a metadata block, it is removed from the metadata hierarchy.

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	wincodec.h
Library	Windowscodecs.lib
DLL	Windowscodecs.dll