ImageFile object

Holds images transferred to your computer when you call Transfer or ShowTransfer. The ImageFile object is a container. It also supports image files through LoadFile. An ImageFile object can be created using "WIA.ImageFile" as the ProgID in a call to CreateObject.

Members

The ImageFile object has these types of members:

Methods

The ImageFile object has these methods.

Method Description
LoadFile Loads the ImageFile object with the specified file.
SaveFile Saves the ImageFile object to the specified file.

Properties

The ImageFile object has these properties.

Property Access type Description
ActiveFrame
Read/write
Sets or retrieves the current frame in the image.
ARGBData
Read-only
Retrieves the raw image bits as a Vector of Long values.
FileData
Read-only
Retrieves the raw image file as a Vector of bytes.
FileExtension
Read-only
Retrieves the file extension for this image file type.
FormatID
Read-only
Retrieves the FormatID for this file type.
FrameCount
Read-only
Retrieves the number of frames in the image.
Height
Read-only
Retrieves the height of the image in pixels.
HorizontalResolution
Read-only
Retrieves the horizontal pixels per inch of the image.
IsAlphaPixelFormat
Read-only
Specifies whether the pixel format has an alpha component.
IsAnimated
Read-only
Specifies whether the image is animated.
IsExtendedPixelFormat
Read-only
Specifies whether the pixel format is extended (16 bits per channel).
IsIndexedPixelFormat
Read-only
Specifies whether the pixel data is an index into a palette or the actual color data.
PixelDepth
Read-only
Retrieves the depth of the pixels of the image in BPP.
Properties (ImageFile)
Read-only
Retrieves an ImageFile collection of all properties for this image.
VerticalResolution
Read-only
Retrieves the vertical pixels per inch of the image.
Width
Read-only
Retrieves the width of the image in pixels.

Remarks

Note that while the ImageFile object is intended for use with image files, non-image files support FileExtension, FileData and SaveFile.

For example code, see Display Detailed Image Information in Shared Samples.

Creation\Access Functions

Use any of the following to retrieve a reference to the object:

ImageFile (Vector)

Apply

ShowAcquireImage

Requirements

Minimum supported client
Windows Vista [desktop apps only]
Minimum supported server
Windows Server 2003 R2 [desktop apps only]
Header
Wiaaut.h
IDL
Wiaaut.idl

See also

Reference

ShowAcquireImage

Apply

ImageFile (Vector)