Ngenuity TWAIN Data Source November 19, 2009
Page 19 of 99
DG_CONTROL|DG_IMAGE|DF_DS2
3.4.3 DG_CONTROL / DAT_STATUS
Supported Messages: MSG_GET (state 4–7)
Responds with the current status (from the last operation), and resets the value to
TWCC_SUCCESS.
Possible values:
TWCC_BADPROTOCOL – unrecognized operation triplet
TWCC_BADVALUE – parameter out of range
TWCC_BUMMER – failure due to unknown causes
TWCC_SEQERROR – operation performed in illegal sequence (unexpected state)
TWCC_OPERATIONERROR – some hardware problem with operation (unknown error)
TWCC_LOWMEMORY – low memory
TWCC_BADCAP – (< 1.6 apps) capability not supported
TWCC_CAPUNSUPPORTED – (> 1.6 apps) capability not supported
TWCC_CAPBADOPERATION – (> 1.6 apps) operation not supported
TWCC_CAPSEQERROR – (> 1.6 apps) capability has dependencies on other caps and cannot be
operated upon at this time
TWCC_PAPERJAM – (>1.8 apps) operation failed due to paper jam
TWCC_CHECKDEVICEONLINE – (>1.8 apps) device is unexpectedly not available
TWCC_PAPERDOUBLEFEED – (>1.8 apps) the feeder detected multiple pages
TWCC_MAXCONNECTIONS – no more apps can Open DS at this time
TWCC_INTERLOCK - (>=2.0 apps) Operation failed because the cover or door is open
3.4.4 DG_IMAGE / DAT_IMAGELAYOUT
Supported Messages: MSG_GET (state 4-6), MSG_GETDEFAULT (state 4-6), MSG_SET (state 4),
and MSG_RESET (state 4)
During MSG_GET operation the TW_IMAGELAYOUT structure shall be filled out as follows:
Frame – shall contain the extents of the current frame
DocumentNumber – shall contain the value of the current document (calculated as the # of batch
scans in this session)
PageNumber – shall contain the value of the current page # (always pending image from state 6)
FrameNumber – shall contain the value of the current frame (always pending image from state 6)
During MSG_GETDEFAULT operation the TW_IMAGELAYOUT structure shall be filled out as
follows:
Frame – shall contain the default ICAP_FRAME
DocumentNumber = 1
PageNumber = 1
FrameNumber = 1
During MSG_SET operation the contents of the TW_IMAGELAYOUT frame shall be accepted as
the “Current” ICAP_FRAME, unless it falls outside of the maximum allowed scanning extents.
Values of DocumentNumber, PageNumber and FrameNumber shall be ignored.