Edit

Share via


IPixelFilter::GetImageInfo method (filter.h)

Implemented by a search filter to provide information about the dimensions and format of the image being indexed.

Syntax

HRESULT GetImageInfo(
  [out] IMAGE_INFO *imageInfo
);

Parameters

[out] imageInfo

An IMAGE_INFO structure specifying the dimensions and format of the image being indexed.

Return value

This method can return one of these values.

Return code Description
S_OK Success
E_OUTOFMEMORY Failed to allocate necessary memory.

Remarks

The indexer calls GetImageInfo first, in order to allocate the necessary buffers for the image. After this method returns, the indexer will call IPixelFilter::GetPixelsForImage one or more times to retrieve the raw image pixels.

Requirements

Requirement Value
Minimum supported client Windows 11, version 26100
Header filter.h