L_TwainSetImageFrame

Summary

Sets the image frame used when transferring images from the current TWAIN source.

Syntax

L_LTTWN_API L_INT L_TwainSetImageFrame(hSession, pFrame)

Parameters

HTWAINSESSION hSession

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

pTW_FRAME pFrame

Pointer to a variable that contains the image frame value to set.

Returns

Comments

The image frame specifies the size and location of the image to acquire. To obtain the current image frame value, call the L_TwainGetImageFrame 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

Functions

• L_TwainSetTransferOptions
• L_TwainGetTransferOptions
• L_TwainGetSupportedTransferMode
• L_TwainSetResolution
• L_TwainGetResolution
• L_TwainGetImageFrame
• L_TwainSetImageUnit
• L_TwainGetImageUnit
• L_TwainSetImageBitsPerPixel
• L_TwainGetImageBitsPerPixel
• L_TwainSetImageEffects
• L_TwainGetImageEffects
• L_TwainSetAcquirePageOptions
• L_TwainGetAcquirePageOptions
• L_TwainSetRGBResponse
• L_TwainShowProgress
• L_TwainEnableDuplex
• L_TwainGetDuplexOptions
• L_TwainSetMaxXferCount
• L_TwainGetMaxXferCount
• L_TwainFloatToFix32

Topics

• Getting and Setting Capabilities
• TWAIN Functionality: Capability Functions

Example

L_INT TwainSetImageFrameExample(HTWAINSESSION hSession) 
{ 
   L_INT nRet = SUCCESS; 
 
   nRet = L_TwainStartCapsNeg(hSession); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   TW_FRAME frame; 
   nRet = L_TwainGetImageFrame (hSession, &frame); 
   if (nRet == SUCCESS) 
   { 
      frame.Left = L_TwainFloatToFix32(0); 
      frame.Top = L_TwainFloatToFix32(0); 
      frame.Right = L_TwainFloatToFix32(8.5); 
      frame.Bottom = L_TwainFloatToFix32(11); 
 
      nRet = L_TwainSetImageFrame(hSession, &frame); 
      if(nRet != SUCCESS) 
         return nRet; 
   } 
   else 
      return nRet; 
 
   nRet = L_TwainEndCapsNeg (hSession); 
   if(nRet != SUCCESS) 
      return nRet; 
   return SUCCESS; 
}