IWICBitmapFrameDecode::GetMetadataQueryReader method (wincodec.h)

Article
02/22/2024

Retrieves a metadata query reader for the frame.

Syntax

HRESULT GetMetadataQueryReader(
  [out] IWICMetadataQueryReader **ppIMetadataQueryReader
);

Parameters

[out] ppIMetadataQueryReader

Type: IWICMetadataQueryReader**

When this method returns, contains a pointer to the frame's metadata query reader.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

For image formats with one frame (JPG, PNG, JPEG-XR), the frame-level query reader of the first frame is used to access all image metadata, and the decoder-level query reader isn’t used. For formats with more than one frame (GIF, TIFF), the frame-level query reader for a given frame is used to access metadata specific to that frame, and in the case of GIF a decoder-level metadata reader will be present. If the decoder doesn’t support metadata (BMP, ICO), this will return WINCODEC_ERR_UNSUPPORTEDOPERATION.

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