DTWAIN_GetAppInfo

Top  Previous  Next

The DTWAIN_GetAppInfo function sets the user application information that is used by TWAIN,

 

DTWAIN_BOOL DTWAIN_GetAppInfo (

LPTSTR

szVersion,

LPTSTR

szManufacturer,

LPTSTR

szProdFamily,

LPTSTR

szProdName );

 

Parameters

szVersion

On return, a null-terminated string identifying the application's version

 

szManufacturer

On return, a null-terminated string identifying the manufacturer.

 

szProdFamily

On return, a null-terminated string identifying the Product Family

 

szProdName

On return, a null-terminated string identifying the Product Name

 

 

Return Values

The return value is TRUE if successful.  Otherwise FALSE is returned.

 

Character specific version

ANSI version:

DTWAIN_GetAppInfoA

Unicode version:

DTWAIN_GetAppInfoW

 

Comments

The DTWAIN_GetAppInfo function gets the user application information that is used by the Source Manager.  The strings can be used for any purpose that the Source Manager and any Sources sees fit.   For example, the Source user interface may display the application version name and manufacturer.  To set these values, the DTWAIN_SetAppInfo function is used.

 

The application version, szVersion, is usually the version of your application.  For example 'Version 2.1'. szManufacturer is usually the manufacturer or creator of your application, for example 'Dumbbell Software'.  The szProdFamily maybe 'Lite Version' and szProdName is usually the name of the application ('Disk Defragger' for example).

 

The application must make sure that szVersion, szManufacturer, szProdFamily, and szProdName are at least 32 characters in length before calling this function, since a maximum of 31 characters plus the trailing NULL will fill these string parameters.

 

Important Note:  Only the first 31 characters of each string parameter are recognized.

 

TWAIN State Transitions

None.

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

 

See Also

DTWAIN_SetAppInfo, DTWAIN_GetCountry, DTWAIN_GetLanguage, DTWAIN_SetCountry, DTWAIN_SetLanguage