IImageDecoder::GetPropertyItem

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method retrieves a specific property item from the current image in the decoder.

Syntax

HRESULT GetPropertyItem(
  PROPID        propId,
  UINT          propSize,
  PropertyItem* buffer
);

Parameters

• propId
  [in] A PROPID value identifying the property item to retrieve.

• propSize
  [in] A UINT value specifying the size, in bytes, of the property item to retrieve.

  To obtain this value, call the IImageDecoder::GetPropertyItemSize method.

• buffer
  [in, out] A pointer to an instance of a PropertyItem class that receives data for the property item.

Return Value

If successful, this method returns S_OK.

If it fails, this method should return one of the following error values:

• IMGERR_PROPERTYNOTFOUND
• E_INVALIDARG

For more information, see Error Codes for the Imaging API.

Requirements

See Also

Reference

IImageDecoder