NotifyIM -- ScanComplete

image\bltlrgss.gif Editions  image\bltlrgss.gif Related Transactions image\bltlrgss.gif Example

The NotifyIM -- ScanComplete notification tells client applications that the scanning operation in the specified document window has been completed.

Type XTYP_ADVSTART or XTYP_ADVSTOP

Item Syntax NotifyIM -- ScanComplete

Type XTYP_ADVDATA

Item Syntax NotifyIM -- ScanComplete

Data Syntax (HWND:docwinID) (FILE:filename) (PAGES:nPages) (CODE:nRetCode)

Parameter

Data type

Values

Meaning

docwinID

DWORD

identifier of the document window

fileName

string

full file name, non-quoted, of the saved scan file

nPages

WORD

number of pages in the scan. See Remarks.

nRetCode

WORD

return code:

 

 

0

Cancel

 

 

1

OK

 

 

2

Failure

Remarks

If doing a batch scan with the Multipage option cleared, this notification is sent after each page is scanned, and nPages always equals 1.

If doing a batch scan with the Multipage option selected, this notification is sent after the entire batch is scanned. nPages is equal to the number of pages scanned.

Release information

Added in Release 4.00.

See also

Requesting notifications