IImage::SetImageFlags

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method is used by applications to set various image flags.

Syntax

HRESULT SetImageFlags(
  UINT flags
);

Parameters

  • flags
    [in] A UINT value containing one or both ImageFlags enumeration values, ImageFlagsReadOnly or ImageFlagsCaching.

Return Value

If successful, this method returns S_OK.

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

  • IMGERR_OBJECTBUSY
  • E_FAIL
  • E_INVALIDARG

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

Remarks

When you set the value of flags to ImageFlagsCaching, it is interpreted as a hint by the image object. The image object makes the final determination as to whether or how the image is cached.

Requirements

Header imaging.h
Library Imaging.lib
Windows Embedded CE Windows CE 5.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

IImage