GetProperties method (ILEADRasterTwain)

Visual Basic Example

Visual C++ 5.0 Example

 

Syntax

short GetProperties();

Overview

Refer to Getting and Setting Capabilities.

Remarks

Gets the current TWAIN source properties from the TWAIN driver.

This method lets the user get information on the properties currently set for the TWAIN driver. It is a high-level alternative to getting individual capabilities using the GetCapability method (MFC) or the GetCapability2 method (VB). For more information on getting and setting TWAIN capabilities, refer to Getting and Setting Capabilities.

Calling this method will update the following properties:

ImageEffects property

DataTransfer property

ImageResolution property

EnableAutoFeed property

MaxPagesNumber property

DuplexScanning property

LeftMargin property

RightMargin property

TopMargin property

BottomMargin property

Note that the ImageEffects, DataTransfer, and ImageResolution properties are read-only interface properties that contain multiple sub-properties. Calling the GetProperties method updates each individual sub-property associated with the three interface properties.

For more information on the available sub-properties, refer to the ImageEffects property, DataTransfer property, and the ImageResolution property.

Not all TWAIN capabilities can be retrieved using the GetProperties method. Depending on the TWAIN source, some capabilities can only be retrieved using the GetCapability method (MFC) or the GetCapability2 method (VB).

For a listing of available capabilities, refer to LEADTOOLS TWAIN Defines.

For more information on specific TWAIN capabilities, refer to the TWAIN 1.9 specification.

To set the document source properties, update all of the properties referenced above and call the SetProperties method, which sets the updated properties to the TWAIN driver.

See Also

Elements

ImageEffects property, DataTransfer property, ImageResolution property, EnableAutoFeed property, MaxPagesNumber property, DuplexScanning property, SetProperties method, LeftMargin property, RightMargin property, TopMargin property, BottomMargin property, Unit property, BitsPerPixel property, HorizontalResolution property, VerticalResolution property, XScaling property, YScaling property, RotationAngle property, FillOrder property, BufferMemoryCompression property, TransferMode property, ScanFileFormat property, MemoryBufferSize property, EnableSaveMultipageFile property, EnableAppendToFile property, EnableDumpMemoryBuffersToFile property, PixelFlavor property, ColorScheme property, HighLight property, Shadow property, Brightness property, Contrast property, HalfTone property, GetCapability method, GetCapability2 method

Topics

TWAIN Functionality: Driver Settings