DTWAIN_LoadCustomStringResources

DTWAIN_LoadCustomStringResourcesA

DTWAIN_LoadCustomStringResourcesW

Top  Previous  Next

The DTWAIN_LoadCustomStringResources loads one of the DTWAIN text resource files for use by DTWAIN.

 

DTWAIN_BOOL DTWAIN_LoadCustomStringResources( LPCTSTR LanguageName );

 

Parameters 

LanguageName

Specifies the name of the language that contains the strings used by DTWAIN.  

 

Return Values

TRUE if successful, FALSE otherwise.  If the function returns FALSE, call DTWAIN_GetLastError() to get extended information.

 

Character specific version (the parameter LanguageName will either be an ANSI or a Unicode string)

ANSI version:

DTWAIN_LoadCustomStringResourcesA

Unicode version:

DTWAIN_LoadCustomStringResourcesW

 

Comments

The DTWAIN_LoadCustomStringResources function allows an application to load a file that contains the language strings used by DTWAIN for error messages (when DTWAIN_GetErrorString is called), when logging messages using DTWAIN_SetTwainLog, for selecting certain resource strings using function DTWAIN_GetResourceString, and for the custom strings used by the TWAIN Select Source dialog whenever DTWAIN_SelectSource2 is called.


Calling DTWAIN_LoadCustomStringResources will use the strings defined in a text file named "twainresourcestrings_<LanguageName>.txt" to override the equivalent strings used for DTWAIN messages.  For example, in C/C++:


DTWAIN_LoadCustomStringResources(_T("french"));


will load the resources found in file "twainresourcestrings_french.txt" (the _T() is a Windows API macro that converts the string-literal to the correct type, depending whether the application is ANSI or Unicode).

 

To create your own custom language resources, refer to the information found here.


TWAIN State Transitions

None

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize