L_TwainSetCustomDSData

#include "l_bitmap.h"

L_LTTWN_API L_INT EXT_FUNCTION L_TwainSetCustomDSData(hSession, pCustomData, pszFileName)

Sets the custom data of TWAIN data source.

This feature is available in LEADTOOLS version 16 or higher.

Parameters

HTWAINSESSION hSession

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

pTW_CUSTOMDSDATA pCustomData

Pointer to a TW_CUSTOMDSDATA structure. This structure must be allocated and contains the custom data of the TWAIN data source to set. Pass NULL if you need to set data from a file.

L_TCHAR * pszFileName

Character string that contains the file name for the custom data of a valid TWAIN data source to load from. Pass NULL to set the data using the pCustomData.

Returns

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

Comments

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

To get the custom data of TWAIN data source, call the L_TwainGetCustomDSData function.

To load the custom data of TWAIN data source from a file, pass a valid file name to pszFileName and NULL to pCustomData.

Required DLLs and Libraries

See Also

Functions

Topics

Example

L_INT TwainSetCustomDSDataExample(HTWAINSESSION hSession, L_TCHAR * pszFileName) 
{ 
   L_TwainStartCapsNeg(hSession); 
   L_INT nRet; 
 
   nRet = L_TwainSetCustomDSData(hSession, NULL, pszFileName); 
   if (nRet != SUCCESS)  
   { 
      MessageBox (NULL, TEXT("Failed to set custom data source data"), TEXT("ERROR"), MB_OK); 
      return nRet; 
   } 
 
   L_TwainEndCapsNeg(hSession); 
   return SUCCESS; 
} 
Help Version 20.0.2020.4.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS TWAIN C API Help