LEADTOOLS TWAIN C++ Class Library Help
| LEADTOOLS TWAIN C++ Class Library Help > Classes and Function References > LTwain > LTwain Class Members > LTwain::GetCustomDSData |
#include "ltwrappr.h"
L_INT LTwain::GetCustomDSData(pCustomData, pszFileName)
|
pTW_CUSTOMDSDATA pCustomData; |
/* pointer to TW_CUSTOMDSDATA structure to be filled */ |
|
L_TCHAR * pszFileName; |
/* file name to save */ |
Gets the custom data of the TWAIN data source and save it to a file. This feature is available in version 16 or higher.
|
Parameter |
Description |
|
pCustomData |
Pointer to a TW_CUSTOMDSDATA structure. This structure must be allocated and it will be filled with the custom data source data. For more information refer to the TWAIN 1.9 specification from the site "http://www.twain.org/". |
|
pszFileName |
Character string that contains a file name to save the custom data of TWAIN data source to. Pass NULL to not save the data to a file. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
To set the custom data of the TWAIN data source, call the LTwain::SetCustomDSData function.
To save the custom data of TWAIN data source to a file, pass a valid file name to the pszFileName. If you pass NULL, the data will return only to pCustomData. Also, you should pass a valid pointer to TW_CUSTOMDSDATA 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. |
See Also
|
Functions: |
LTwain::SetCustomDSData, LTwain::GetCapability, LTwain::SetCapability |
|
Topics: |
|
|
|
Example
