In This Topic ▼

LTwain::SetCustomDSData

Summary

Sets the custom data of the TWAIN data source. This feature is available in version 16 or higher.

Syntax

#include "ltwrappr.h"

L_INT LTwain::SetCustomDSData(pCustomData, pszFileName)

Parameters

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 the data from a file.

L_TCHAR * pszFileName

Character string that contains a 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

To get the custom data of the TWAIN data source, call the LTwain::GetCustomDSData function.

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

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.

Example

L_INT LTwain__SetCustomDSDataExample(LTwain * plTwain, L_TCHAR * pszFileName) 
{ 
   L_INT nRet; 
   nRet = plTwain->SetCustomDSData(NULL, pszFileName); 
   if(nRet != SUCCESS) 
   { 
      MessageBox (NULL, TEXT("Failed to set custom data source data"), TEXT("ERROR"), 
MB_OK); 
      return nRet; 
   } 
    
   return SUCCESS; 
}