L_TwainSetResolution

Summary

Sets the horizontal and vertical resolution used to transfer images from the current TWAIN source.

Syntax

#include "lttwn.h"

L_LTTWN_API L_INT L_TwainSetResolution(hSession, pXRes, pYRes)

Parameters

HTWAINSESSION hSession

Handle to an existing TWAIN session. This handle is obtained by calling the L_TwainInitSession or L_TwainInitSession2 function.

pTW_FIX32 pXRes

The horizontal resolution value to set.

pTW_FIX32 pYRes

The vertical resolution value to set.

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

This function internally sets the horizontal and vertical resolution capabilities ICAP_XRESOLUTION and ICAP_YRESOLUTION. For more information on these capabilities, refer to the TWAIN specification.

To obtain the current resolution value, call the L_TwainGetResolution function.

This function should be called after calling the L_TwainStartCapsNeg function and before calling the L_TwainEndCapsNeg function.

Required DLLs and Libraries

See Also

Functions

Topics

Example

L_INT TwainSetResolutionExample(HTWAINSESSION hSession) 
{ 
   L_INT nRet = SUCCESS; 
 
   nRet = L_TwainStartCapsNeg (hSession); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   TW_FIX32 XRes, YRes; 
   nRet = L_TwainGetResolution (hSession, &XRes, &YRes); 
   if (nRet == SUCCESS) 
   { 
      if (L_TwainFix32ToFloat(&XRes) != 300.0f) 
      { 
         XRes = L_TwainFloatToFix32(300.0f); 
         YRes = L_TwainFloatToFix32(300.0f);       
 
         nRet = L_TwainSetResolution(hSession, &XRes, &YRes); 
         if(nRet != SUCCESS) 
            return nRet; 
      } 
   } 
   else 
      return nRet; 
 
   nRet = L_TwainEndCapsNeg (hSession); 
   if(nRet != SUCCESS) 
      return nRet; 
   return SUCCESS; 
} 
Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS TWAIN C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.