LEADTOOLS TWAIN C DLL Help > Function References > L_TwainSetResolution |
#include "lttwn.h"
L_LTTWN_API L_INT L_TwainSetResolution(hSession, pXRes, pYRes)
HTWAINSESSION hSession; |
/* handle to an existing TWAIN session */ |
pTW_FIX32 pXRes; |
/* pointer to a variable */ |
pTW_FIX32 pYRes; |
/* pointer to a variable */ |
Sets the horizontal and vertical resolution used to transfer images from the current TWAIN source.
Parameter |
Description |
hSession |
Handle to an existing TWAIN session. This handle is obtained by calling the L_TwainInitSession function. |
pXRes |
The horizontal resolution value to set. |
pYRes |
The vertical resolution value to set. |
Returns
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 www.twain.org/download.htm and click on TWAIN Specification (Version 1.9).
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
LTTWN For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
See Also
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; }