DTWAIN_SetAppInfo

Top Previous Next

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

DTWAIN_BOOL DTWAIN_SetAppInfo (

LPCTSTR	szVersion,
LPCTSTR	szManufacturer,
LPCTSTR	szProdFamily,
LPCTSTR	szProdName );

Parameters

szVersion

Points to a null-terminated string identifying the application's version

szManufacturer

Points to a null-terminated string identifying the manufacturer.

szProdFamily

Points to a null-terminated string identifying the Product Family

szProdName

Points to 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_SetAppInfoA
Unicode version:	DTWAIN_SetAppInfoW

Comments

The DTWAIN_SetAppInfo function sets 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. These strings are not mandatory, but it is always a good idea to set these values to whatever strings you feel are appropriate.

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).

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

If DTWAIN_SetAppInfo is not called, all of the information strings default to the character sequence '<?>'.

DTWAIN_SetAppInfo must be called before the TWAIN session is started with (done by calling or before a Source is initially selected), since a TWAIN session sends the application information to the TWAIN Source Manager.

TWAIN State Transitions

None.

Prerequisite Function Call(s)

DTWAIN_SysInitialize