DTWAIN_GetConstantFromTwainName

DTWAIN_GetConstantFromTwainNameA

DTWAIN_GetConstantFromTwainNameW

Top  Previous  Next

The DTWAIN_GetConstantFromTwainName function returns the integer constant that represents a TWAIN or DTWAIN name.

 

LONG DTWAIN_GetConstantFromTwainName ( LPCTSTR szBuffer )


 Parameters

 

szBuffer

String that represenst the TWAIN name.

 

 

Return Values

If the function succeeds, the constant value that represents the name szBuffer is returned.  If the function fails, -2147483648 is returned.

 

Character specific version

ANSI version:

DTWAIN_GetConstantFromTwainNameA

Unicode version:

DTWAIN_GetConstantFromTwainNameW

 

Comments

The DTWAIN_GetConstantFromTwainName function is a utility function that returns the integer constant of the TWAIN or DTWAIN name in szBuffer.  



A small C/C++ example of usage of DTWAIN_GetConstantFromTwainName:


LONG value = DTWAIN_GetConstantFromTwainNameA( "TWPT_BW" );  // value1 will be 0

LONG value2 = DTWAIN_GetConstantFromTwainNameA( "DAT_IDENTITY" ); // value2 will be 3


Note that the value of TWPT_BW is actually 0, and DAT_IDENTITY is 3 (these values are in the header file twain.h).  


If the name is not known to have a constant value, -2147483648 is returned.


If you want to get the TWAIN name from a known constant, see DTWAIN_GetTwainNameFromConstant.

 

TWAIN State Transitions

None.

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize