ImageCodecInfo

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This class is used to create objects that describe the characteristics of an image decoder or an image encoder.

Syntax

class ImageCodecInfo {
  public:          
    CLSID        Clsid;
    GUID         FormatID;
    const WCHAR* CodecName;
    const WCHAR* DllName;
    const WCHAR* FormatDescription;
    const WCHAR* FilenameExtension;
    const WCHAR* MimeType;
    DWORD        Flags;
    DWORD        Version;
    DWORD        SigCount;
    DWORD        SigSize;
    const BYTE*  SigPattern;
    const BYTE*  SigMask;
};

Data Members

• Clsid
  A CLSID value specifying the class ID for the codec's COM component.

• FormatID
  A GUID value identifying the image format that the codec supports.

  This value should be an image format identifier. For more information, see Imaging GUIDs.

• CodecName
  A pointer to a WCHAR array containing the name of the codec.

• DllName
  A pointer to a WCHAR array containing the name of the codec's DLL.

• FormatDescription
  A pointer to a WCHAR array containing a string describing the codec's supported image format.

  This string is to be used for the filter string in the lpstrFilter member of the OPENFILENAME structure; for example, Windows Bitmap.

• FilenameExtension
  A pointer to a WCHAR array containing the file name extensions for the file format supported by the codec.

  Multiple extensions are separated by semicolons; for example, *.BMP;*.DIB.

• MimeType
  A pointer to a WCHAR array containing the name of the MIME type for the file format supported by the codec; for example, image/bmp.

• Flags
  A DWORD value containing one or more flags from the ImageCodecFlags enumeration.

• Version
  A DWORD value specifying the version of the codec

• SigCount
  A DWORD value specifying the number of file header signatures.

  This is normally 1, but could be more for file formats that have multiple signatures. In the latter case, set SigSize to the largest of all file header signatures.

• SigSize
  A DWORD value specifying the number of bytes for each file header signature.

  This is only required for decoders.

• SigPattern
  A pointer to an array of BYTE values defining the expected file header signature pattern.

  The size of this array is sigCount * sigSize bytes.

  The first sigSize bytes are used for the first signature, the second sigSize bytes are used for the second signature, and so on.

• SigMask
  A pointer to an array of BYTE values containing masks applied to the file header bytes before they are compared to the header pattern.

  The size of this array is sigCount * sigSize bytes.

Requirements

See Also

Reference

Imaging Classes
Imaging GUIDs
ImageCodecFlags

Other Resources

OPENFILENAME