DTWAIN_SetPrinterStringMode

Top  Previous  Next

The DTWAIN_SetPrinterStringMode function sets the current Imprinter/Endorser string mode (Single, Multi, or Compound Strings).

 

DTWAIN_BOOL DTWAIN_SetPrinterStringMode (

DTWAIN_SOURCE

Source,

LONG

StringMode,

DTWAIN_BOOL

bSetCurrent );

 

Parameters

Source

An open TWAIN Source.

 

StringMode

The string mode to set.

 

bSetCurrent

Determines whether to set the current string mode or use the default string mode.

 

Return Values

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

 

Comments

The DTWAIN_SetPrinterStringMode function sets the current imprinter/endorser string mode for the Source Source.  The StringMode is the string mode to set.  If bSetCurrent is TRUE, the string mode StringMode is set.  If bSetCurrent is FALSE, the default string mode is used, and the StringMode argument is ignored.

 

Setting the string mode allows the application to specify whether the imprinter/endorser will use single line strings, multi-line strings, or compound strings (a string consisting of a string, plus some other data). The value of StringMode can be any one of the following:

 

String Mode

Definition

DTWAIN_PM_SINGLESTRING

Use single line strings.

DTWAIN_PM_MULTISTRING

Use multiple strings.

DTWAIN_PM_COMPOUNDSTRING

Use Compound strings.

 

TWAIN State Transitions

The Source must be in State 4. or higher

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

 

DTWAIN Source Selection Function

 

 

See Also

Imprinter / Endorser Support