IWICMetadataQueryWriter::RemoveMetadataByName method

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

Syntax


HRESULT RemoveMetadataByName(
  [in] LPCWSTR wzName
);

Parameters

wzName [in]

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

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

Wincodec.h

IDL

Wincodec.idl

Library

Windowscodecs.lib

DLL

Windowscodecs.dll

See also

IWICMetadataQueryWriter
Conceptual
WIC Metadata Overview
Metadata Query Language Overview
Overview of Reading and Writing Image Metadata
How-to: Re-encode a JPEG Image with Metadata

 

 

Show: