DTWAIN_GetResolution

Top  Previous  Next

The DTWAIN_GetResolution function gets the current resolution value for the Source.

 

DTWAIN_BOOL DTWAIN_GetResolution (

DTWAIN_SOURCE

Source,

LPDTWAIN_FLOAT

lpResolution );

 

Parameters

Source

An open TWAIN Source.

 

lpResolution

Address of a DTWAIN_FLOAT  (LPDTWAIN_FLOAT ).  On return, this is filled in with the current resolution.

 

Return Values

The return value is TRUE if successful.  Otherwise FALSE is returned.

 

Comments

The DTWAIN_GetResolution function gets the current resolution value for the  Source Source and on return, fills the DTWAIN_FLOAT that lpResolution points to .  Please note that lpResolution is an address of a DTWAIN_FLOAT (an LPDTWAIN_FLOAT).

 

Note that some Sources do not support retrieving the resolution, so the return value for DTWAIN_GetResolution will always be FALSE.

 

To set the current resolution value, call DTWAIN_SetResolution.

 

For languages that have difficulties with DTWAIN_FLOAT parameters, the alternate function that can be used as a replacement for DTWAIN_GetResolution is DTWAIN_GetResolutionString.

 

TWAIN State Transitions

The Source must be in State 4. or higher

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize.

DTWAIN Source Selection Function

 

 

See Also

Setting / Getting X-Y Resolution Values